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


База данных Microsoft.DocumentDB/sqlDatabases 2024-11-15

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

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

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-11-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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

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

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

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

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

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

ResourceRestoreParameters

Имя Описание Ценность
restoreSource Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} струна
restoreTimestampInUtc Время восстановления учетной записи (формат ISO-8601). струна
restoreWithTtlDisabled Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении. bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

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

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Имя Описание Ценность
createMode Перечисление, указывающее режим создания ресурсов. По умолчанию
"Восстановить"
идентификатор Имя базы данных SQL Cosmos DB строка (обязательно)
restoreParameters Параметры для указания сведений о восстановлении ResourceRestoreParameters

Теги

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

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

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

Bicep-файл Описание
API SQL учетной записи Azure Cosmos DB с аналитическим хранилищем Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером, настроенным с помощью аналитического хранилища.
Создание учетной записи Azure Cosmos DB уровня "Бесплатный" Этот шаблон создает бесплатную учетную запись Azure Cosmos DB для API SQL с базой данных с общей пропускной способностью и контейнером.
создание учетной записи Azure Cosmos DB для API Core (SQL) Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью с несколькими другими параметрами.
создание API SQL учетной записи Azure Cosmos DB с автомасштабированием Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью автомасштабирования с несколькими другими параметрами.
Создание хранимых процедур API Azure Cosmos DB Core (SQL) Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL) и контейнер с хранимой процедурой, триггером и определяемой пользователем функцией.
создает приложение микрослужб Dapr с помощью приложений контейнеров Создайте приложение микрослужб Dapr с помощью контейнерных приложений.
Создает приложение dapr pub-sub servicebus с помощью приложений контейнеров Создайте приложение dapr pub-sub servicebus с помощью контейнерных приложений.
Развертывание базы данных Azure Data Explorer с помощью подключения Cosmos DB Разверните базу данных Azure Data Explorer с подключением Cosmos DB.

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

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

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

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

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2024-11-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

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

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

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Имя Описание Ценность
apiVersion Версия API '2024-11-15'
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
свойства Свойства для создания и обновления базы данных SQL Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/sqlDatabases"

ResourceRestoreParameters

Имя Описание Ценность
restoreSource Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} струна
restoreTimestampInUtc Время восстановления учетной записи (формат ISO-8601). струна
restoreWithTtlDisabled Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении. bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

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

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Имя Описание Ценность
createMode Перечисление, указывающее режим создания ресурсов. По умолчанию
"Восстановить"
идентификатор Имя базы данных SQL Cosmos DB строка (обязательно)
restoreParameters Параметры для указания сведений о восстановлении ResourceRestoreParameters

Теги

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

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

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

Шаблон Описание
API SQL учетной записи Azure Cosmos DB с аналитическим хранилищем

развертывание в Azure
Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером, настроенным с помощью аналитического хранилища.
Создание учетной записи Azure Cosmos DB уровня "Бесплатный"

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

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

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

развертывание в Azure
Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL) и контейнер с хранимой процедурой, триггером и определяемой пользователем функцией.
создает приложение микрослужб Dapr с помощью приложений контейнеров

развертывание в Azure
Создайте приложение микрослужб Dapr с помощью контейнерных приложений.
Создает приложение dapr pub-sub servicebus с помощью приложений контейнеров

развертывание в Azure
Создайте приложение dapr pub-sub servicebus с помощью контейнерных приложений.
Развертывание базы данных Azure Data Explorer с помощью подключения Cosmos DB

развертывание в Azure
Разверните базу данных Azure Data Explorer с подключением Cosmos DB.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-11-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
      }
    }
  })
}

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

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

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

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Имя Описание Ценность
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: databaseAccounts
свойства Свойства для создания и обновления базы данных SQL Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-11-15"

ResourceRestoreParameters

Имя Описание Ценность
restoreSource Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/location/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} струна
restoreTimestampInUtc Время восстановления учетной записи (формат ISO-8601). струна
restoreWithTtlDisabled Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении. bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

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

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Имя Описание Ценность
createMode Перечисление, указывающее режим создания ресурсов. По умолчанию
"Восстановить"
идентификатор Имя базы данных SQL Cosmos DB строка (обязательно)
restoreParameters Параметры для указания сведений о восстановлении ResourceRestoreParameters

Теги

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