Restorable Sql Containers - List

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

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

Параметры URI

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

string

Идентификатор GUID instanceId восстанавливаемой учетной записи базы данных.

location
path True

string

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

subscriptionId
path True

string

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

api-version
query True

string

Версия 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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

CosmosDBRestorableSqlContainerList

Sample Request

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

Sample Response

{
  "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

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

ErrorResponse

Ответ об ошибке.

ExcludedPath
IncludedPath

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

Indexes

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

IndexingMode

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

IndexingPolicy

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

IndexKind

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

OperationType

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

PartitionKind

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

Resource

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

ResourceRestoreParameters

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

RestorableSqlContainerGetResult

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

RestorableSqlContainersListResult

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

SpatialSpec
SpatialType

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

UniqueKey

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

UniqueKeyPolicy

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

ClientEncryptionIncludedPath

.

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

string

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

encryptionAlgorithm

string

Используемый алгоритм шифрования. Например, AEAD_AES_256_CBC_HMAC_SHA256.

encryptionType

string

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

path

string

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

ClientEncryptionPolicy

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

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

ClientEncryptionIncludedPath[]

Пути к элементу, которому требуется шифрование, а также параметры для конкретных путей.

policyFormatVersion

integer

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

CloudError

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

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

ErrorResponse

Ответ об ошибке.

CompositePath

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

CompositePathSortOrder

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

path

string

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

CompositePathSortOrder

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

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

string

descending

string

ComputedProperty

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

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

string

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

query

string

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

ConflictResolutionMode

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

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

string

LastWriterWins

string

ConflictResolutionPolicy

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

Имя Тип Значение по умолчанию Описание
conflictResolutionPath

string

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

conflictResolutionProcedure

string

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

mode

ConflictResolutionMode

LastWriterWins

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

Container

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

Имя Тип Значение по умолчанию Описание
_etag

string

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

_rid

string

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

_self

string

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

_ts

number

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

analyticalStorageTtl

integer

Аналитический срок жизни.

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.

ContainerPartitionKey

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

Имя Тип Значение по умолчанию Описание
kind

PartitionKind

Hash

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

paths

string[]

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

systemKey

boolean

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

version

integer

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

CreateMode

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

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

string

Restore

string

DataType

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

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

string

MultiPolygon

string

Number

string

Point

string

Polygon

string

String

string

ErrorResponse

Ответ об ошибке.

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

string

Код ошибки.

message

string

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

ExcludedPath

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

string

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

IncludedPath

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

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

Indexes[]

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

path

string

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

Indexes

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

Имя Тип Значение по умолчанию Описание
dataType

DataType

String

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

kind

IndexKind

Hash

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

precision

integer

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

IndexingMode

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

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

string

lazy

string

none

string

IndexingPolicy

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

Имя Тип Значение по умолчанию Описание
automatic

boolean

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

compositeIndexes

CompositePath[]

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

excludedPaths

ExcludedPath[]

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

includedPaths

IncludedPath[]

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

indexingMode

IndexingMode

consistent

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

spatialIndexes

SpatialSpec[]

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

IndexKind

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

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

string

Range

string

Spatial

string

OperationType

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

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

string

Delete

string

Recreate

string

Replace

string

SystemOperation

string

PartitionKind

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

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

string

MultiHash

string

Range

string

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/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}

restoreTimestampInUtc

string

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

RestorableSqlContainerGetResult

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

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

string

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

name

string

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

properties.resource

Resource

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

type

string

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

RestorableSqlContainersListResult

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

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

RestorableSqlContainerGetResult[]

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

SpatialSpec

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

string

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

types

SpatialType[]

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

SpatialType

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

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

string

MultiPolygon

string

Point

string

Polygon

string

UniqueKey

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

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

string[]

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

UniqueKeyPolicy

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

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

UniqueKey[]

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