Restorable Sql Containers - List

Odwołanie

Usługa:: Cosmos DB Resource Provider

Wersja interfejsu API:: 2024-11-15

Pokaż zestawienie zdarzeń wszystkich mutacji wykonanych we wszystkich kontenerach SQL usługi Azure Cosmos DB w ramach określonej bazy danych. Pomaga to w scenariuszu, w którym kontener został przypadkowo usunięty. Ten interfejs API wymaga uprawnienia "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read"

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2024-11-15

Z parametrami opcjonalnymi:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2024-11-15&restorableSqlDatabaseRid={restorableSqlDatabaseRid}&startTime={startTime}&endTime={endTime}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
instanceId	path	True	string	Identyfikator GUID wystąpienia konta bazy danych z możliwością przywracania.
location	path	True	string	Region usługi Cosmos DB ze spacjami między wyrazami i każdym wyrazem wielkich liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
endTime	query		string	Czas zakończenia źródła zdarzeń kontenerów Sql można przywrócić.
restorableSqlDatabaseRid	query		string	Identyfikator zasobu bazy danych SQL.
startTime	query		string	Czas rozpoczęcia źródła zdarzeń kontenerów SQL można przywrócić.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RestorableSqlContainersListResult	Operacja została ukończona pomyślnie.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Przykłady

CosmosDBRestorableSqlContainerList

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers?api-version=2024-11-15&restorableSqlDatabaseRid=3fu-hg==

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/79609a98-3394-41f8-911f-cfab0c075c86",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers",
      "name": "79609a98-3394-41f8-911f-cfab0c075c86",
      "properties": {
        "resource": {
          "_rid": "zAyAPQAAAA==",
          "eventTimestamp": "2020-10-13T04:56:42Z",
          "ownerId": "Container1",
          "ownerResourceId": "V18LoLrv-qA=",
          "operationType": "Create",
          "canUndelete": "invalid",
          "container": {
            "id": "Container1",
            "indexingPolicy": {
              "indexingMode": "consistent",
              "automatic": true,
              "includedPaths": [
                {
                  "path": "/*"
                },
                {
                  "path": "/\"_ts\"/?"
                }
              ],
              "excludedPaths": [
                {
                  "path": "/\"_etag\"/?"
                }
              ]
            },
            "conflictResolutionPolicy": {
              "mode": "LastWriterWins",
              "conflictResolutionPath": "/_ts",
              "conflictResolutionProcedure": ""
            },
            "_rid": "V18LoLrv-qA=",
            "_self": "dbs/V18LoA==/colls/V18LoLrv-qA=/",
            "_etag": "\"00003e00-0000-0700-0000-5f85338a0000\""
          }
        }
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/e85298a1-c631-4726-825e-a7ca092e9098",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers",
      "name": "e85298a1-c631-4726-825e-a7ca092e9098",
      "properties": {
        "resource": {
          "_rid": "PrArcgAAAA==",
          "eventTimestamp": "2020-10-13T05:03:27Z",
          "ownerId": "Container1",
          "ownerResourceId": "V18LoLrv-qA=",
          "operationType": "Replace",
          "canUndelete": "invalid",
          "container": {
            "id": "Container1",
            "indexingPolicy": {
              "indexingMode": "consistent",
              "automatic": true,
              "includedPaths": [
                {
                  "path": "/*"
                },
                {
                  "path": "/\"_ts\"/?"
                }
              ],
              "excludedPaths": [
                {
                  "path": "/\"_etag\"/?"
                }
              ]
            },
            "defaultTtl": 12345,
            "conflictResolutionPolicy": {
              "mode": "LastWriterWins",
              "conflictResolutionPath": "/_ts",
              "conflictResolutionProcedure": ""
            },
            "_rid": "V18LoLrv-qA=",
            "_self": "dbs/V18LoA==/colls/V18LoLrv-qA=/",
            "_etag": "\"00004400-0000-0700-0000-5f85351f0000\""
          }
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Zasady szyfrowania klienta usługi Cosmos DB.
CloudError	Odpowiedź na błąd z usługi.
CompositePath
CompositePathSortOrder	Kolejność sortowania dla ścieżek złożonych.
ComputedProperty	Definicja obliczonej właściwości
ConflictResolutionMode	Wskazuje tryb rozwiązywania konfliktów.
ConflictResolutionPolicy	Zasady rozwiązywania konfliktów dla kontenera.
Container	Obiekt zasobu kontenera SQL usługi Cosmos DB
ContainerPartitionKey	Konfiguracja klucza partycji, który ma być używany do partycjonowania danych na wiele partycji
CreateMode	Wyliczenie wskazujące tryb tworzenia konta.
DataType	Typ danych, dla którego zastosowano zachowanie indeksowania.
DistanceFunction	Funkcja odległości używana do obliczania odległości między wektorami.
ErrorResponse	Odpowiedź na błąd.
ExcludedPath
IncludedPath	Ścieżki uwzględnione w indeksowaniu
Indexes	Indeksy ścieżki.
IndexingMode	Wskazuje tryb indeksowania.
IndexingPolicy	Zasady indeksowania usługi Cosmos DB
IndexKind	Wskazuje typ indeksu.
OperationType	Wyliczenie wskazujące typ operacji zdarzenia.
PartitionKind	Wskazuje rodzaj algorytmu używanego do partycjonowania. W przypadku funkcji MultiHash obsługa wielu kluczy partycji (maksymalnie trzech) jest obsługiwanych w przypadku tworzenia kontenera
Resource	Zasób zdarzenia kontenera SQL usługi Azure Cosmos DB
ResourceRestoreParameters	Parametry wskazujące informacje o przywracaniu.
RestorableSqlContainerGetResult	Zdarzenie kontenera SQL usługi Azure Cosmos DB
RestorableSqlContainersListResult	Odpowiedź operacji Lista zawierająca zdarzenia kontenera SQL i ich właściwości.
SpatialSpec
SpatialType	Wskazuje typ przestrzenny indeksu.
UniqueKey	Unikatowy klucz, który wymusza ograniczenie unikatowości dla dokumentów w kolekcji w usłudze Azure Cosmos DB.
UniqueKeyPolicy	Unikatowa konfiguracja zasad klucza służący do określania ograniczeń unikatowości dokumentów w kolekcji w usłudze Azure Cosmos DB.
VectorDataType	Wskazuje typ danych wektora.
VectorEmbedding	Reprezentuje osadzanie wektorów. Osadzanie wektorów służy do definiowania pola wektorowego w dokumentach.
VectorEmbeddingPolicy	Zasady osadzania wektorów usługi Cosmos DB
VectorIndex
VectorIndexType	Typ indeksu wektora. Obecnie obsługiwane są płaskie, diskANN i kwantyzowaneFlat.

ClientEncryptionIncludedPath

Nazwa	Typ	Opis
clientEncryptionKeyId	string	Identyfikator klucza szyfrowania klienta, który ma być używany do szyfrowania ścieżki.
encryptionAlgorithm	string	Algorytm szyfrowania, który będzie używany. Na przykład — AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType	string	Typ szyfrowania do wykonania. Na przykład — deterministyczne, randomizowane.
path	string	Ścieżka, która musi być zaszyfrowana.

ClientEncryptionPolicy

Zasady szyfrowania klienta usługi Cosmos DB.

Nazwa	Typ	Opis
includedPaths	ClientEncryptionIncludedPath[]	Ścieżki elementu, który wymaga szyfrowania wraz z ustawieniami specyficznymi dla ścieżki.
policyFormatVersion	integer	Wersja definicji zasad szyfrowania klienta. Obsługiwane wersje to 1 i 2. Wersja 2 obsługuje szyfrowanie ścieżki identyfikatora i klucza partycji.

CloudError

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd.

CompositePath

Nazwa	Typ	Opis
order	CompositePathSortOrder	Kolejność sortowania dla ścieżek złożonych.
path	string	Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*)

CompositePathSortOrder

Kolejność sortowania dla ścieżek złożonych.

Nazwa	Typ	Opis
ascending	string
descending	string

ComputedProperty

Definicja obliczonej właściwości

Nazwa	Typ	Opis
name	string	Nazwa obliczonej właściwości, na przykład " cp_lowerName"
query	string	Zapytanie, które oblicza wartość obliczonej właściwości, na przykład " SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

Wskazuje tryb rozwiązywania konfliktów.

Nazwa	Typ	Opis
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

Zasady rozwiązywania konfliktów dla kontenera.

Nazwa	Typ	Domyślna wartość	Opis
conflictResolutionPath	string		Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins.
conflictResolutionProcedure	string		Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego.
mode	ConflictResolutionMode	LastWriterWins	Wskazuje tryb rozwiązywania konfliktów.

Container

Obiekt zasobu kontenera SQL usługi Cosmos DB

Nazwa	Typ	Domyślna wartość	Opis
_etag	string		Właściwość wygenerowana przez system reprezentująca element etag zasobu wymagany do optymistycznej kontroli współbieżności.
_rid	string		Właściwość wygenerowana przez system. Unikatowy identyfikator.
_self	string		Właściwość wygenerowana przez system określająca adresową ścieżkę zasobu kontenera.
_ts	number		Właściwość wygenerowana przez system, która określa ostatnio zaktualizowany znacznik czasu zasobu.
analyticalStorageTtl	integer		Analityczny czas wygaśnięcia.
clientEncryptionPolicy	ClientEncryptionPolicy		Zasady szyfrowania klienta dla kontenera.
computedProperties	ComputedProperty[]		Lista obliczonych właściwości
conflictResolutionPolicy	ConflictResolutionPolicy		Zasady rozwiązywania konfliktów dla kontenera.
createMode	CreateMode	Default	Wyliczenie wskazujące tryb tworzenia zasobów.
defaultTtl	integer		Domyślny czas wygaśnięcia
id	string		Nazwa kontenera SQL usługi Cosmos DB
indexingPolicy	IndexingPolicy		Konfiguracja zasad indeksowania. Domyślnie indeksowanie jest automatyczne dla wszystkich ścieżek dokumentów w kontenerze
partitionKey	ContainerPartitionKey		Konfiguracja klucza partycji, który ma być używany do partycjonowania danych na wiele partycji
restoreParameters	ResourceRestoreParameters		Parametry wskazujące informacje o przywracaniu
uniqueKeyPolicy	UniqueKeyPolicy		Unikatowa konfiguracja zasad klucza służący do określania ograniczeń unikatowości dokumentów w kolekcji w usłudze Azure Cosmos DB.
vectorEmbeddingPolicy	VectorEmbeddingPolicy		Zasady osadzania wektorów dla kontenera.

ContainerPartitionKey

Konfiguracja klucza partycji, który ma być używany do partycjonowania danych na wiele partycji

Nazwa	Typ	Domyślna wartość	Opis
kind	PartitionKind	Hash	Wskazuje rodzaj algorytmu używanego do partycjonowania. W przypadku funkcji MultiHash obsługa wielu kluczy partycji (maksymalnie trzech) jest obsługiwanych w przypadku tworzenia kontenera
paths	string[]		Lista ścieżek, w których można partycjonować dane w kontenerze
systemKey	boolean		Wskazuje, czy kontener używa klucza partycji wygenerowanego przez system
version	integer		Wskazuje wersję definicji klucza partycji

CreateMode

Wyliczenie wskazujące tryb tworzenia konta.

Nazwa	Typ	Opis
Default	string
Restore	string

DataType

Typ danych, dla którego zastosowano zachowanie indeksowania.

Nazwa	Typ	Opis
LineString	string
MultiPolygon	string
Number	string
Point	string
Polygon	string
String	string

DistanceFunction

Funkcja odległości używana do obliczania odległości między wektorami.

Nazwa	Typ	Opis
cosine	string
dotproduct	string
euclidean	string

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ExcludedPath

Nazwa	Typ	Opis
path	string	Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*)

IncludedPath

Ścieżki uwzględnione w indeksowaniu

Nazwa	Typ	Opis
indexes	Indexes[]	Lista indeksów dla tej ścieżki
path	string	Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*)

Indexes

Indeksy ścieżki.

Nazwa	Typ	Domyślna wartość	Opis
dataType	DataType	String	Typ danych, dla którego zastosowano zachowanie indeksowania.
kind	IndexKind	Hash	Wskazuje typ indeksu.
precision	integer		Precyzja indeksu. -1 jest maksymalną precyzją.

IndexingMode

Wskazuje tryb indeksowania.

Nazwa	Typ	Opis
consistent	string
lazy	string
none	string

IndexingPolicy

Zasady indeksowania usługi Cosmos DB

Nazwa	Typ	Domyślna wartość	Opis
automatic	boolean		Wskazuje, czy zasady indeksowania są automatyczne
compositeIndexes	CompositePath[]		Lista listy ścieżek złożonych
excludedPaths	ExcludedPath[]		Lista ścieżek do wykluczenia z indeksowania
includedPaths	IncludedPath[]		Lista ścieżek do uwzględnienia w indeksowaniu
indexingMode	IndexingMode	consistent	Wskazuje tryb indeksowania.
spatialIndexes	SpatialSpec[]		Lista specyfiki przestrzennej
vectorIndexes	VectorIndex[]		Lista ścieżek do uwzględnienia w indeksowaniu wektorowym

IndexKind

Wskazuje typ indeksu.

Nazwa	Typ	Opis
Hash	string
Range	string
Spatial	string

OperationType

Wyliczenie wskazujące typ operacji zdarzenia.

Nazwa	Typ	Opis
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

PartitionKind

Wskazuje rodzaj algorytmu używanego do partycjonowania. W przypadku funkcji MultiHash obsługa wielu kluczy partycji (maksymalnie trzech) jest obsługiwanych w przypadku tworzenia kontenera

Nazwa	Typ	Opis
Hash	string
MultiHash	string
Range	string

Resource

Zasób zdarzenia kontenera SQL usługi Azure Cosmos DB

Nazwa	Typ	Opis
_rid	string	Właściwość wygenerowana przez system. Unikatowy identyfikator.
canUndelete	string	Stan tego kontenera do określenia, czy ten kontener można przywrócić na tym samym koncie.
canUndeleteReason	string	Powód, dla którego nie można przywrócić tego kontenera na tym samym koncie.
container	Container	Obiekt zasobu kontenera SQL usługi Cosmos DB
eventTimestamp	string	Czas wystąpienia tego zdarzenia kontenera.
operationType	OperationType	Typ operacji tego zdarzenia kontenera.
ownerId	string	Nazwa tego kontenera SQL.
ownerResourceId	string	Identyfikator zasobu tego kontenera SQL.

ResourceRestoreParameters

Parametry wskazujące informacje o przywracaniu.

Nazwa	Typ	Opis
restoreSource	string	Identyfikator przywracalnego konta bazy danych, z którego należy zainicjować przywracanie. Na przykład: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Godzina przywrócenia konta (format ISO-8601).
restoreWithTtlDisabled	boolean	Określa, czy przywrócone konto będzie mieć czas-To-Live wyłączone po pomyślnym przywróceniu.

RestorableSqlContainerGetResult

Zdarzenie kontenera SQL usługi Azure Cosmos DB

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator zasobu usługi ARM.
name	string	Nazwa zasobu usługi ARM.
properties.resource	Resource	Zasób zdarzenia kontenera SQL usługi Azure Cosmos DB
type	string	Typ zasobu platformy Azure.