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

База данных Microsoft.DocumentDBAccounts/gremlinDatabases/graphs 2020-04-01

  • Статья

Определение ресурсов Bicep

Тип ресурса databaseAccounts/gremlinDatabases/graphs можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-04-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          [
            {
              order: 'string'
              path: 'string'
            }
          ]
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Значения свойств

АвтомасштабированиеSettings

Имя Описание Ценность
maxThroughput Представляет максимальную пропускную способность, ресурс может масштабироваться до. int

Составной Путь

Имя Описание Ценность
порядок Порядок сортировки составных путей. "Возрастание"
"Убывание"
путь Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*) струна

ConflictResolutionPolicy

Имя Описание Ценность
conflictResolutionPath Путь разрешения конфликтов в режиме LastWriterWins. струна
conflictResolutionProcedure Процедура разрешения конфликтов в случае пользовательского режима. струна
режим Указывает режим разрешения конфликтов. "Custom"
"LastWriterWins"

ContainerPartitionKey

Имя Описание Ценность
добрый Указывает тип алгоритма, используемого для секционирования Хэш
"Диапазон"
Пути Список путей, с помощью которых можно секционировать данные в контейнере string[]
Версия Указывает версию определения ключа секции int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Имя Описание Ценность
autoscaleSettings Задает параметры автомасштабирования. AutoscaleSettings
производительность Единицы запроса в секунду. Например, "пропускная способность": 10000. int

ИсключенныйPath

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

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Имя Описание Ценность
Параметры Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions (обязательно)
ресурс Стандартный формат JSON графа Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (обязательно)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Имя Описание Ценность
conflictResolutionPolicy Политика разрешения конфликтов для графа. ConflictResolutionPolicy
defaultTtl Время жизни по умолчанию int
идентификатор Имя графа Gremlin Cosmos DB строка (обязательно)
indexingPolicy Конфигурация политики индексирования. По умолчанию индексирование выполняется автоматически для всех путей документа в графе. IndexingPolicy
partitionKey Конфигурация ключа секции, используемого для секционирования данных на несколько секций ContainerPartitionKey
uniqueKeyPolicy Конфигурация уникальной политики ключей для указания ограничений уникальности для документов в коллекции в службе Azure Cosmos DB. UniqueKeyPolicy

Включенныйpath

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

Индексы

Имя Описание Ценность
dataType Тип данных, к которому применяется индексирование. LineString
'MultiPolygon'
"Число"
"Точка"
"Многоугольник"
"String"
добрый Указывает тип индекса. Хэш
"Диапазон"
"Пространственный"
точность Точность индекса. -1 — максимальная точность. int

IndexingPolicy

Имя Описание Ценность
Автоматически Указывает, является ли политика индексирования автоматической bool
составныеIndexes Список составных путей CompositePath[][]
excludedPaths Список путей для исключения из индексирования ИсключенныйPath[]
включенныеPaths Список путей для включения в индексирование IncludedPath[]
indexingMode Указывает режим индексирования. "Согласованный"
"Ленивый"
"Нет"
spatialIndexes Список пространственных особенностей SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Имя Описание Ценность
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: databaseAccounts/gremlinDatabases
свойства Свойства для создания и обновления графа Gremlin в Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

SpatialSpec

Имя Описание Ценность
путь Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*) струна
Типы Список пространственного типа пути Массив строк, содержащий любой из:
LineString
'MultiPolygon'
"Точка"
"Многоугольник"

Теги

Имя Описание Ценность

UniqueKey

Имя Описание Ценность
Пути Список путей должен быть уникальным для каждого документа в службе Azure Cosmos DB. string[]

UniqueKeyPolicy

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

Примеры краткого руководства

Следующие примеры краткого руководства по развертыванию этого типа ресурса.

Bicep-файл Описание
Создание учетной записи Azure Cosmos DB для API Gremlin Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с выделенной пропускной способностью.
Создание учетной записи Azure Cosmos DB для автомасштабирования API Gremlin Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с помощью пропускной способности автомасштабирования.

Определение ресурса шаблона ARM

Тип ресурса databaseAccounts/gremlinDatabases/graphs можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
  "apiVersion": "2020-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          [
            {
              "order": "string",
              "path": "string"
            }
          ]
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ]
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Значения свойств

АвтомасштабированиеSettings

Имя Описание Ценность
maxThroughput Представляет максимальную пропускную способность, ресурс может масштабироваться до. int

Составной Путь

Имя Описание Ценность
порядок Порядок сортировки составных путей. "Возрастание"
"Убывание"
путь Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*) струна

ConflictResolutionPolicy

Имя Описание Ценность
conflictResolutionPath Путь разрешения конфликтов в режиме LastWriterWins. струна
conflictResolutionProcedure Процедура разрешения конфликтов в случае пользовательского режима. струна
режим Указывает режим разрешения конфликтов. "Custom"
"LastWriterWins"

ContainerPartitionKey

Имя Описание Ценность
добрый Указывает тип алгоритма, используемого для секционирования Хэш
"Диапазон"
Пути Список путей, с помощью которых можно секционировать данные в контейнере string[]
Версия Указывает версию определения ключа секции int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Имя Описание Ценность
autoscaleSettings Задает параметры автомасштабирования. AutoscaleSettings
производительность Единицы запроса в секунду. Например, "пропускная способность": 10000. int

ИсключенныйPath

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

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Имя Описание Ценность
Параметры Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions (обязательно)
ресурс Стандартный формат JSON графа Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (обязательно)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Имя Описание Ценность
conflictResolutionPolicy Политика разрешения конфликтов для графа. ConflictResolutionPolicy
defaultTtl Время жизни по умолчанию int
идентификатор Имя графа Gremlin Cosmos DB строка (обязательно)
indexingPolicy Конфигурация политики индексирования. По умолчанию индексирование выполняется автоматически для всех путей документа в графе. IndexingPolicy
partitionKey Конфигурация ключа секции, используемого для секционирования данных на несколько секций ContainerPartitionKey
uniqueKeyPolicy Конфигурация уникальной политики ключей для указания ограничений уникальности для документов в коллекции в службе Azure Cosmos DB. UniqueKeyPolicy

Включенныйpath

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

Индексы

Имя Описание Ценность
dataType Тип данных, к которому применяется индексирование. LineString
'MultiPolygon'
"Число"
"Точка"
"Многоугольник"
"String"
добрый Указывает тип индекса. Хэш
"Диапазон"
"Пространственный"
точность Точность индекса. -1 — максимальная точность. int

IndexingPolicy

Имя Описание Ценность
Автоматически Указывает, является ли политика индексирования автоматической bool
составныеIndexes Список составных путей CompositePath[][]
excludedPaths Список путей для исключения из индексирования ИсключенныйPath[]
включенныеPaths Список путей для включения в индексирование IncludedPath[]
indexingMode Указывает режим индексирования. "Согласованный"
"Ленивый"
"Нет"
spatialIndexes Список пространственных особенностей SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Имя Описание Ценность
apiVersion Версия API '2020-04-01'
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
свойства Свойства для создания и обновления графа Gremlin в Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs"

SpatialSpec

Имя Описание Ценность
путь Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*) струна
Типы Список пространственного типа пути Массив строк, содержащий любой из:
LineString
'MultiPolygon'
"Точка"
"Многоугольник"

Теги

Имя Описание Ценность

UniqueKey

Имя Описание Ценность
Пути Список путей должен быть уникальным для каждого документа в службе Azure Cosmos DB. string[]

UniqueKeyPolicy

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

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Создание учетной записи Azure Cosmos DB для API Gremlin

развертывание в Azure		 Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с выделенной пропускной способностью.
Создание учетной записи Azure Cosmos DB для автомасштабирования API Gremlin

развертывание в Azure		 Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с помощью пропускной способности автомасштабирования.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса databaseAccounts/gremlinDatabases/graphs можно развернуть с помощью операций, предназначенных для следующих операций:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-04-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            [
              {
                order = "string"
                path = "string"
              }
            ]
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Значения свойств

АвтомасштабированиеSettings

Имя Описание Ценность
maxThroughput Представляет максимальную пропускную способность, ресурс может масштабироваться до. int

Составной Путь

Имя Описание Ценность
порядок Порядок сортировки составных путей. "Возрастание"
"Убывание"
путь Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*) струна

ConflictResolutionPolicy

Имя Описание Ценность
conflictResolutionPath Путь разрешения конфликтов в режиме LastWriterWins. струна
conflictResolutionProcedure Процедура разрешения конфликтов в случае пользовательского режима. струна
режим Указывает режим разрешения конфликтов. "Custom"
"LastWriterWins"

ContainerPartitionKey

Имя Описание Ценность
добрый Указывает тип алгоритма, используемого для секционирования Хэш
"Диапазон"
Пути Список путей, с помощью которых можно секционировать данные в контейнере string[]
Версия Указывает версию определения ключа секции int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 2

CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions

Имя Описание Ценность
autoscaleSettings Задает параметры автомасштабирования. AutoscaleSettings
производительность Единицы запроса в секунду. Например, "пропускная способность": 10000. int

ИсключенныйPath

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

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

Имя Описание Ценность
Параметры Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. CreateUpdateOptionsOrGremlinGraphGetPropertiesOptions (обязательно)
ресурс Стандартный формат JSON графа Gremlin GremlinGraphResourceOrGremlinGraphGetPropertiesResource (обязательно)

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

Имя Описание Ценность
conflictResolutionPolicy Политика разрешения конфликтов для графа. ConflictResolutionPolicy
defaultTtl Время жизни по умолчанию int
идентификатор Имя графа Gremlin Cosmos DB строка (обязательно)
indexingPolicy Конфигурация политики индексирования. По умолчанию индексирование выполняется автоматически для всех путей документа в графе. IndexingPolicy
partitionKey Конфигурация ключа секции, используемого для секционирования данных на несколько секций ContainerPartitionKey
uniqueKeyPolicy Конфигурация уникальной политики ключей для указания ограничений уникальности для документов в коллекции в службе Azure Cosmos DB. UniqueKeyPolicy

Включенныйpath

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

Индексы

Имя Описание Ценность
dataType Тип данных, к которому применяется индексирование. LineString
'MultiPolygon'
"Число"
"Точка"
"Многоугольник"
"String"
добрый Указывает тип индекса. Хэш
"Диапазон"
"Пространственный"
точность Точность индекса. -1 — максимальная точность. int

IndexingPolicy

Имя Описание Ценность
Автоматически Указывает, является ли политика индексирования автоматической bool
составныеIndexes Список составных путей CompositePath[][]
excludedPaths Список путей для исключения из индексирования ИсключенныйPath[]
включенныеPaths Список путей для включения в индексирование IncludedPath[]
indexingMode Указывает режим индексирования. "Согласованный"
"Ленивый"
"Нет"
spatialIndexes Список пространственных особенностей SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

Имя Описание Ценность
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: databaseAccounts/gremlinDatabases
свойства Свойства для создания и обновления графа Gremlin в Azure Cosmos DB. GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-04-01"

SpatialSpec

Имя Описание Ценность
путь Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*) струна
Типы Список пространственного типа пути Массив строк, содержащий любой из:
LineString
'MultiPolygon'
"Точка"
"Многоугольник"

Теги

Имя Описание Ценность

UniqueKey

Имя Описание Ценность
Пути Список путей должен быть уникальным для каждого документа в службе Azure Cosmos DB. string[]

UniqueKeyPolicy

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