共用方式為

Microsoft.DocumentDB 資料庫Accounts/gremlinDatabases 2024-11-15

  • 發行項

Bicep 資源定義

databaseAccounts/gremlinDatabases 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/gremlinDatabases 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@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'
  }
}

屬性值

AutoscaleSettings

名字 描述 價值
maxThroughput 代表最大輸送量，資源可以相應增加至 。 int

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

名字 描述 價值
autoscaleSettings 指定自動調整設定。 注意：需要輸送量或自動調整設定，但不需要兩者。 AutoscaleSettings
輸送量 每秒要求單位數。 例如，「輸送量」：10000。 int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

名字 描述 價值
選項 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
資源 Gremlin 資料庫的標準 JSON 格式 GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource （必要）

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

名字 描述 價值
createMode 列舉，表示資源建立模式。 'Default'
'Restore'
id Cosmos DB Gremlin 資料庫的名稱 字串 （必要）
restoreParameters 用來指出還原相關信息的參數 ResourceRestoreParameters

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

名字 描述 價值
位置 資源所屬資源群組的位置。 字串
名字 資源名稱 字串 （必要）
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱：databaseAccounts
性能 建立及更新 Azure Cosmos DB Gremlin 資料庫的屬性。 GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

ResourceRestoreParameters

名字 描述 價值
restoreSource 必須起始還原的可還原資料庫帳戶標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} 字串
restoreTimestampInUtc 帳戶必須還原的時間（ISO-8601 格式）。 字串
restoreWithTtlDisabled 指定還原的帳戶是否會在成功還原時停用時間To-Live。 bool

標籤

名字 描述 價值

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案 描述
為 Gremlin API 建立 Azure Cosmos DB 帳戶 此範本會在兩個區域中建立適用於 Gremlin API 的 Azure Cosmos DB 帳戶，其中一個資料庫和一個圖表使用專用輸送量。
為 Gremlin API 自動調整 建立 Azure Cosmos DB 帳戶 此範本會使用自動調整輸送量，在兩個區域中建立 Gremlin API 的 Azure Cosmos DB 帳戶，其中一個資料庫和一個圖形。

ARM 樣本資源定義

databaseAccounts/gremlinDatabases 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/gremlinDatabases 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
  "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"
  }
}

屬性值

AutoscaleSettings

名字 描述 價值
maxThroughput 代表最大輸送量，資源可以相應增加至 。 int

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

名字 描述 價值
autoscaleSettings 指定自動調整設定。 注意：需要輸送量或自動調整設定，但不需要兩者。 AutoscaleSettings
輸送量 每秒要求單位數。 例如，「輸送量」：10000。 int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

名字 描述 價值
選項 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
資源 Gremlin 資料庫的標準 JSON 格式 GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource （必要）

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

名字 描述 價值
createMode 列舉，表示資源建立模式。 'Default'
'Restore'
id Cosmos DB Gremlin 資料庫的名稱 字串 （必要）
restoreParameters 用來指出還原相關信息的參數 ResourceRestoreParameters

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

名字 描述 價值
apiVersion API 版本 '2024-11-15'
位置 資源所屬資源群組的位置。 字串
名字 資源名稱 字串 （必要）
性能 建立及更新 Azure Cosmos DB Gremlin 資料庫的屬性。 GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases'

ResourceRestoreParameters

名字 描述 價值
restoreSource 必須起始還原的可還原資料庫帳戶標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} 字串
restoreTimestampInUtc 帳戶必須還原的時間（ISO-8601 格式）。 字串
restoreWithTtlDisabled 指定還原的帳戶是否會在成功還原時停用時間To-Live。 bool

標籤

名字 描述 價值

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
為 Gremlin API 建立 Azure Cosmos DB 帳戶

部署至 Azure 		此範本會在兩個區域中建立適用於 Gremlin API 的 Azure Cosmos DB 帳戶，其中一個資料庫和一個圖表使用專用輸送量。
為 Gremlin API 自動調整 建立 Azure Cosmos DB 帳戶

部署至 Azure 		此範本會使用自動調整輸送量，在兩個區域中建立 Gremlin API 的 Azure Cosmos DB 帳戶，其中一個資料庫和一個圖形。

Terraform （AzAPI 提供者） 資源定義

databaseAccounts/gremlinDatabases 資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/gremlinDatabases 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@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
        }
      }
    }
  })
}

屬性值

AutoscaleSettings

名字 描述 價值
maxThroughput 代表最大輸送量，資源可以相應增加至 。 int

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

名字 描述 價值
autoscaleSettings 指定自動調整設定。 注意：需要輸送量或自動調整設定，但不需要兩者。 AutoscaleSettings
輸送量 每秒要求單位數。 例如，「輸送量」：10000。 int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

名字 描述 價值
選項 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
資源 Gremlin 資料庫的標準 JSON 格式 GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource （必要）

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

名字 描述 價值
createMode 列舉，表示資源建立模式。 'Default'
'Restore'
id Cosmos DB Gremlin 資料庫的名稱 字串 （必要）
restoreParameters 用來指出還原相關信息的參數 ResourceRestoreParameters

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

名字 描述 價值
位置 資源所屬資源群組的位置。 字串
名字 資源名稱 字串 （必要）
parent_id 此資源為父系之資源的標識碼。 類型資源的標識碼：databaseAccounts
性能 建立及更新 Azure Cosmos DB Gremlin 資料庫的屬性。 GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties （必要）
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-11-15”

ResourceRestoreParameters

名字 描述 價值
restoreSource 必須起始還原的可還原資料庫帳戶標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} 字串
restoreTimestampInUtc 帳戶必須還原的時間（ISO-8601 格式）。 字串
restoreWithTtlDisabled 指定還原的帳戶是否會在成功還原時停用時間To-Live。 bool

標籤

名字 描述 價值