Microsoft.DocumentDB databaseAccounts/gremlinDatabases/graphs 2020-03-01

• Актуальная
• 2024-05-15
• 15.05.2024 г.
• 15.02.2024 г.
• 2023-11-15
• 15.11.2023 г.
• 2023-09-15
• 15.09.2023 г.
• 2023-04-15
• 2023-03-15
• 15.03.2023 г.
• 2023-03-01-preview
• 2022-11-15
• 15.11.2022 г.
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 15.02.2022 г.
• 15.11.2021-preview
• 2021-10-15
• 15.10.2021 г.
• 2021-07-01-preview
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 2021-01-15
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 01.08.2019

Определение ресурса Bicep

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

• Группы ресурсов — см. команды развертывания группы ресурсов.

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      throughput: 'string'
      {customized property}: 'string'
    }
    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'
            ]
          }
        ]
      }
    }
  }
}

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

databaseAccounts/gremlinDatabases/graphs

Имя	Описание	Значение
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.	строка (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB".	Словарь имен и значений тегов. См . раздел Теги в шаблонах
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа: gremlinDatabases
properties	Свойства для создания и обновления графа Gremlin в Azure Cosmos DB.	GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (обязательно)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...

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

CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...

Имя	Описание	Значение
throughput	Количество запросов в секунду. Например, "пропускная способность": "10000".	строка
{настроенное свойство}		строка

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

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

ConflictResolutionPolicy

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

IndexingPolicy

Имя	Описание	Значение
automatic	Указывает, является ли политика индексирования автоматической.	bool
compositeIndexes	Список составных путей	CompositePath[]
excludedPaths	Список путей для исключения из индексирования	ExcludedPath[]
includedPaths	Список путей для включения в индексирование	IncludedPath[]
indexingMode	Указывает режим индексирования.	"Согласованный" "Ленивый" "Нет"
spatialIndexes	Список пространственных особенностей	SpatialSpec[]

CompositePath

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

ExcludedPath

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

IncludedPath

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

Индексы

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

SpatialSpec

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

ContainerPartitionKey

Имя	Описание	Значение
kind	Указывает тип алгоритма, используемого для секционирования.	"Хэш" 'Range'
пути	Список путей, по которым можно секционировать данные в контейнере	string[]
version	Указывает версию определения ключа секции.	INT Ограничения: Минимальное значение = 1 Максимальное значение = 2

UniqueKeyPolicy

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

UniqueKey

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

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

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

Шаблон	Описание
Создание учетной записи 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-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "throughput": "string",
      "{customized property}": "string"
    },
    "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" ]
          }
        ]
      }
    }
  }
}

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

databaseAccounts/gremlinDatabases/graphs

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs
версия_API	Версия API ресурсов	'2020-03-01'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	string (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, по умолчанию для типа шаблона задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают Table, Graph, DocumentDB и MongoDB.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties	Свойства для создания и обновления графа Gremlin в Azure Cosmos DB.	GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (обязательно)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...

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

CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...

Имя	Описание	Значение
throughput	Количество запросов в секунду. Например, "пропускная способность": "10000".	строка
{настроенное свойство}		строка

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

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

ConflictResolutionPolicy

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

IndexingPolicy

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

CompositePath

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

ExcludedPath

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

IncludedPath

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

Индексы

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

SpatialSpec

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

ContainerPartitionKey

Имя	Описание	Значение
kind	Указывает тип алгоритма, используемого для секционирования.	"Хэш" "Диапазон"
пути	Список путей, по которым можно секционировать данные в контейнере	string[]
version	Указывает версию определения ключа секции.	INT Ограничения: Минимальное значение = 1 Максимальное значение = 2

UniqueKeyPolicy

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

UniqueKey

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

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

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

Шаблон	Описание
Создание учетной записи Azure Cosmos DB для API Gremlin	Этот шаблон создает учетную запись Azure Cosmos DB для API Gremlin в двух регионах с одной базой данных и одним графом с использованием выделенной пропускной способности.
Создание учетной записи Azure Cosmos DB для автомасштабирования API Gremlin	Этот шаблон создает учетную запись 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-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        throughput = "string"
        {customized property} = "string"
      }
      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"
              ]
            }
          ]
        }
      }
    }
  })
}

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

databaseAccounts/gremlinDatabases/graphs

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2020-03-01"
name	имя ресурса.	string (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа : gremlinDatabases
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, по умолчанию для типа шаблона задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают Table, Graph, DocumentDB и MongoDB.	Словарь имен и значений тегов.
properties	Свойства для создания и обновления графа Gremlin в Azure Cosmos DB.	GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (обязательно)

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...

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

CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...

Имя	Описание	Значение
throughput	Количество запросов в секунду. Например, "пропускная способность": "10000".	строка
{настраиваемое свойство}		строка

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

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

ConflictResolutionPolicy

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

IndexingPolicy

Имя	Описание	Значение
automatic	Указывает, является ли политика индексирования автоматической.	bool
compositeIndexes	Список составных путей	CompositePath[]
excludedPaths	Список путей для исключения из индексирования	ExcludedPath[]
includedPaths	Список путей для включения в индексирование	IncludedPath[]
indexingMode	Указывает режим индексирования.	"Согласованный" "Ленивый" "None"
spatialIndexes	Список пространственных особенностей	SpatialSpec[]

CompositePath

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

ExcludedPath

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

IncludedPath

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

Индексы

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

SpatialSpec

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

ContainerPartitionKey

Имя	Описание	Значение
kind	Указывает тип алгоритма, используемого для секционирования.	"Хэш" "Диапазон"
пути	Список путей, по которым можно секционировать данные в контейнере	string[]
version	Указывает версию определения ключа секции.	INT Ограничения: Минимальное значение = 1 Максимальное значение = 2

UniqueKeyPolicy

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

UniqueKey

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