Поделиться через


Restorable Sql Containers - List

Отображение канала событий всех изменений, выполненных во всех контейнерах SQL Azure Cosmos DB в определенной базе данных. Это помогает в сценарии, когда контейнер был случайно удален. Для этого API требуется разрешение "Microsoft.DocumentDB/location/restorableDatabaseAccounts/.../read"

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

Параметры URI

Имя В Обязательно Тип Описание
instanceId
path True

string

ИДЕНТИФИКАТОР GUID экземпляра учетной записи базы данных, допускающего восстановление.

location
path True

string

Регион Cosmos DB с пробелами между словами и каждой прописной буквой слова.

subscriptionId
path True

string

minLength: 1

Идентификатор целевой подписки.

api-version
query True

string

minLength: 1

Версия API, используемая для этой операции.

endTime
query

string

Время окончания веб-канала событий контейнеров SQL с возможностью восстановления.

restorableSqlDatabaseRid
query

string

Идентификатор ресурса базы данных SQL.

startTime
query

string

Время начала запуска веб-канала событий контейнеров SQL с возможностью восстановления.

Ответы

Имя Тип Описание
200 OK

RestorableSqlContainersListResult

Операция успешно завершена.

Other Status Codes

CloudError

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation Олицетворения учетной записи пользователя

Примеры

CosmosDBRestorableSqlContainerList

Образец запроса

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==

Пример ответа

{
  "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\""
          }
        }
      }
    }
  ]
}

Определения

Имя Описание
ClientEncryptionIncludedPath

.

ClientEncryptionPolicy

Политика шифрования клиента Cosmos DB.

CloudError

Ответ на ошибку службы.

CompositePath
CompositePathSortOrder

Порядок сортировки составных путей.

ComputedProperty

Определение вычисляемого свойства

ConflictResolutionMode

Указывает режим разрешения конфликтов.

ConflictResolutionPolicy

Политика разрешения конфликтов для контейнера.

Container

Объект ресурса контейнера SQL Cosmos DB

ContainerPartitionKey

Конфигурация ключа секции, используемого для секционирования данных на несколько секций

CreateMode

Перечисление, указывающее режим создания учетной записи.

DataType

Тип данных, к которому применяется индексирование.

DistanceFunction

Функция расстояния, используемая для вычисления расстояния между векторами.

ErrorResponse

Ответ на ошибку.

ExcludedPath
IncludedPath

Пути, включенные в индексирование

Indexes

Индексы для пути.

IndexingMode

Указывает режим индексирования.

IndexingPolicy

Политика индексирования Cosmos DB

IndexKind

Указывает тип индекса.

OperationType

Перечисление, указывающее тип операции события.

PartitionKind

Указывает тип алгоритма, используемого для секционирования. Для MultiHash для создания контейнера поддерживаются несколько ключей секций (не более трех).

Resource

Ресурс события контейнера SQL Azure Cosmos DB

ResourceRestoreParameters

Параметры для указания сведений о восстановлении.

RestorableSqlContainerGetResult

Событие контейнера SQL Azure Cosmos DB

RestorableSqlContainersListResult

Ответ операции списка, содержащий события контейнера SQL и их свойства.

SpatialSpec
SpatialType

Указывает пространственный тип индекса.

UniqueKey

Уникальный ключ, который обеспечивает ограничение уникальности документов в коллекции в службе Azure Cosmos DB.

UniqueKeyPolicy

Конфигурация уникальной политики ключей для указания ограничений уникальности для документов в коллекции в службе Azure Cosmos DB.

VectorDataType

Указывает тип данных вектора.

VectorEmbedding

Представляет вектор внедрения. Внедрение вектора используется для определения поля вектора в документах.

VectorEmbeddingPolicy

Политика внедрения вектора Cosmos DB

VectorIndex
VectorIndexType

Тип индекса вектора. В настоящее время поддерживаются плоская, дисковая, дисковая и квантизованнаяFlat.

ClientEncryptionIncludedPath

.

Имя Тип Описание
clientEncryptionKeyId

string

Идентификатор ключа шифрования клиента, который будет использоваться для шифрования пути.

encryptionAlgorithm

string

Алгоритм шифрования, который будет использоваться. Eg - AEAD_AES_256_CBC_HMAC_SHA256.

encryptionType

string

Тип выполняемого шифрования. Например, детерминированное, случайное.

path

string

Путь, который необходимо зашифровать.

ClientEncryptionPolicy

Политика шифрования клиента Cosmos DB.

Имя Тип Описание
includedPaths

ClientEncryptionIncludedPath[]

Пути элемента, нуждающегося в шифровании, вместе с параметрами конкретного пути.

policyFormatVersion

integer (int32)

minimum: 1
maximum: 2

Версия определения политики шифрования клиента. Поддерживаемые версии: 1 и 2. Версия 2 поддерживает шифрование пути идентификатора и ключа секции.

CloudError

Ответ на ошибку службы.

Имя Тип Описание
error

ErrorResponse

Ответ на ошибку.

CompositePath

Имя Тип Описание
order

CompositePathSortOrder

Порядок сортировки составных путей.

path

string

Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*)

CompositePathSortOrder

Порядок сортировки составных путей.

Значение Описание
ascending
descending

ComputedProperty

Определение вычисляемого свойства

Имя Тип Описание
name

string

Имя вычисляемого свойства, например "cp_lowerName"

query

string

Запрос, вычисляющий значение вычисляемого свойства, например "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

Указывает режим разрешения конфликтов.

Значение Описание
Custom
LastWriterWins

ConflictResolutionPolicy

Политика разрешения конфликтов для контейнера.

Имя Тип Default value Описание
conflictResolutionPath

string

Путь разрешения конфликтов в режиме LastWriterWins.

conflictResolutionProcedure

string

Процедура разрешения конфликтов в случае пользовательского режима.

mode

ConflictResolutionMode

LastWriterWins

Указывает режим разрешения конфликтов.

Container

Объект ресурса контейнера SQL Cosmos DB

Имя Тип Default value Описание
_etag

string

Созданное системой свойство, представляющее etag ресурса, необходимое для управления оптимистичным параллелизмом.

_rid

string

Созданное системой свойство. Уникальный идентификатор.

_self

string

Созданное системой свойство, указывающее адресный путь ресурса контейнера.

_ts

number

Созданное системой свойство, обозначающее последнюю обновленную метку времени ресурса.

analyticalStorageTtl

integer (int64)

Аналитический TTL.

clientEncryptionPolicy

ClientEncryptionPolicy

Политика шифрования клиента для контейнера.

computedProperties

ComputedProperty[]

Список вычисляемых свойств

conflictResolutionPolicy

ConflictResolutionPolicy

Политика разрешения конфликтов для контейнера.

createMode

CreateMode

Default

Перечисление, указывающее режим создания ресурсов.

defaultTtl

integer

Время жизни по умолчанию

id

string

Имя контейнера SQL Cosmos DB

indexingPolicy

IndexingPolicy

Конфигурация политики индексирования. По умолчанию индексирование выполняется автоматически для всех путей к документам в контейнере.

partitionKey

ContainerPartitionKey

Конфигурация ключа секции, используемого для секционирования данных на несколько секций

restoreParameters

ResourceRestoreParameters

Параметры для указания сведений о восстановлении

uniqueKeyPolicy

UniqueKeyPolicy

Конфигурация уникальной политики ключей для указания ограничений уникальности для документов в коллекции в службе Azure Cosmos DB.

vectorEmbeddingPolicy

VectorEmbeddingPolicy

Политика внедрения вектора для контейнера.

ContainerPartitionKey

Конфигурация ключа секции, используемого для секционирования данных на несколько секций

Имя Тип Default value Описание
kind

PartitionKind

Hash

Указывает тип алгоритма, используемого для секционирования. Для MultiHash для создания контейнера поддерживаются несколько ключей секций (не более трех).

paths

string[]

Список путей, с помощью которых можно секционировать данные в контейнере

systemKey

boolean

Указывает, использует ли контейнер ключ секции, созданный системой

version

integer (int32)

minimum: 1
maximum: 2

Указывает версию определения ключа секции

CreateMode

Перечисление, указывающее режим создания учетной записи.

Значение Описание
Default
Restore

DataType

Тип данных, к которому применяется индексирование.

Значение Описание
LineString
MultiPolygon
Number
Point
Polygon
String

DistanceFunction

Функция расстояния, используемая для вычисления расстояния между векторами.

Значение Описание
cosine
dotproduct
euclidean

ErrorResponse

Ответ на ошибку.

Имя Тип Описание
code

string

Код ошибки.

message

string

Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ExcludedPath

Имя Тип Описание
path

string

Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*)

IncludedPath

Пути, включенные в индексирование

Имя Тип Описание
indexes

Indexes[]

Список индексов для этого пути

path

string

Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*)

Indexes

Индексы для пути.

Имя Тип Default value Описание
dataType

DataType

String

Тип данных, к которому применяется индексирование.

kind

IndexKind

Hash

Указывает тип индекса.

precision

integer

Точность индекса. -1 — максимальная точность.

IndexingMode

Указывает режим индексирования.

Значение Описание
consistent
lazy
none

IndexingPolicy

Политика индексирования Cosmos DB

Имя Тип Default value Описание
automatic

boolean

Указывает, является ли политика индексирования автоматической

compositeIndexes

CompositePath[]

Список составных путей

excludedPaths

ExcludedPath[]

Список путей для исключения из индексирования

includedPaths

IncludedPath[]

Список путей для включения в индексирование

indexingMode

IndexingMode

consistent

Указывает режим индексирования.

spatialIndexes

SpatialSpec[]

Список пространственных особенностей

vectorIndexes

VectorIndex[]

Список путей для включения в векторного индексирования

IndexKind

Указывает тип индекса.

Значение Описание
Hash
Range
Spatial

OperationType

Перечисление, указывающее тип операции события.

Значение Описание
Create
Delete
Recreate
Replace
SystemOperation

PartitionKind

Указывает тип алгоритма, используемого для секционирования. Для MultiHash для создания контейнера поддерживаются несколько ключей секций (не более трех).

Значение Описание
Hash
MultiHash
Range

Resource

Ресурс события контейнера SQL Azure Cosmos DB

Имя Тип Описание
_rid

string

Созданное системой свойство. Уникальный идентификатор.

canUndelete

string

Состояние этого контейнера, определяющее, можно ли восстановить этот контейнер в той же учетной записи.

canUndeleteReason

string

Причина, по которой этот контейнер не может быть восстановлен в той же учетной записи.

container

Container

Объект ресурса контейнера SQL Cosmos DB

eventTimestamp

string

Событие этого контейнера.

operationType

OperationType

Тип операции этого события контейнера.

ownerId

string

Имя этого контейнера SQL.

ownerResourceId

string

Идентификатор ресурса этого контейнера SQL.

ResourceRestoreParameters

Параметры для указания сведений о восстановлении.

Имя Тип Описание
restoreSource

string

Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}

restoreTimestampInUtc

string (date-time)

Время восстановления учетной записи (формат ISO-8601).

restoreWithTtlDisabled

boolean

Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении.

RestorableSqlContainerGetResult

Событие контейнера SQL Azure Cosmos DB

Имя Тип Описание
id

string

Уникальный идентификатор ресурса ARM.

name

string

Имя ресурса ARM.

properties.resource

Resource

Ресурс события контейнера SQL Azure Cosmos DB

type

string

Тип ресурса Azure.

RestorableSqlContainersListResult

Ответ операции списка, содержащий события контейнера SQL и их свойства.

Имя Тип Описание
value

RestorableSqlContainerGetResult[]

Список событий контейнера SQL и их свойств.

SpatialSpec

Имя Тип Описание
path

string

Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*)

types

SpatialType[]

Список пространственного типа пути

SpatialType

Указывает пространственный тип индекса.

Значение Описание
LineString
MultiPolygon
Point
Polygon

UniqueKey

Уникальный ключ, который обеспечивает ограничение уникальности документов в коллекции в службе Azure Cosmos DB.

Имя Тип Описание
paths

string[]

Список путей должен быть уникальным для каждого документа в службе Azure Cosmos DB.

UniqueKeyPolicy

Конфигурация уникальной политики ключей для указания ограничений уникальности для документов в коллекции в службе Azure Cosmos DB.

Имя Тип Описание
uniqueKeys

UniqueKey[]

Список уникальных ключей, которые применяют ограничение уникальности для документов в коллекции в службе Azure Cosmos DB.

VectorDataType

Указывает тип данных вектора.

Значение Описание
float32
int8
uint8

VectorEmbedding

Представляет вектор внедрения. Внедрение вектора используется для определения поля вектора в документах.

Имя Тип Описание
dataType

VectorDataType

Указывает тип данных вектора.

dimensions

integer (int32)

Количество измерений в векторе.

distanceFunction

DistanceFunction

Функция расстояния, используемая для вычисления расстояния между векторами.

path

string

Путь к полю вектора в документе.

VectorEmbeddingPolicy

Политика внедрения вектора Cosmos DB

Имя Тип Описание
vectorEmbeddings

VectorEmbedding[]

Список внедрения векторов

VectorIndex

Имя Тип Описание
path

string

Путь к полю вектора в документе.

type

VectorIndexType

Тип индекса вектора. В настоящее время поддерживаются плоская, дисковая, дисковая и квантизованнаяFlat.

VectorIndexType

Тип индекса вектора. В настоящее время поддерживаются плоская, дисковая, дисковая и квантизованнаяFlat.

Значение Описание
diskANN
flat
quantizedFlat