Share via


Microsoft.DocumentDB 資料庫Accounts/cassandraKeyspaces/tables 2022-02-15-preview

Bicep 資源定義

databaseAccounts/cassandraKeyspaces/tables 資源類型可以使用目標作業來部署:

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

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables 資源,請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2022-02-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      defaultTtl: int
      id: 'string'
      schema: {
        clusterKeys: [
          {
            name: 'string'
            orderBy: 'string'
          }
        ]
        columns: [
          {
            name: 'string'
            type: 'string'
          }
        ]
        partitionKeys: [
          {
            name: 'string'
          }
        ]
      }
    }
  }
}

屬性值

databaseAccounts/cassandraKeyspaces/tables

名稱 描述
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。
字串 (必要)
location 資源所屬資源群組的位置。 字串
tags 標籤是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源,以及對資源分組。 資源最多可提供15個標籤。 每個標記的金鑰都不得多於 128 個字元,值則不得多於 256 個字元。 例如,範本類型的默認體驗設定為 「defaultExperience」:“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 標記名稱和值的字典。 請參閱 範本中的標記
父系 (parent) 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源之外宣告子資源時,才需要新增這個屬性。

如需詳細資訊,請參閱 父資源外部的子資源
類型資源的符號名稱: cassandraKeyspaces
身分識別 資源的身分識別。 ManagedServiceIdentity
properties 用來建立及更新 Azure Cosmos DB Cassandra 數據表的屬性。 CassandraTableCreateUpdatePropertiesOrCassandraTable... 必要 ()

ManagedServiceIdentity

名稱 描述
類型 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned':用於資源的身分識別類型。 類型 'SystemAssigned,UserAssigned' 同時包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。
userAssignedIdentities 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名稱 描述
{自定義屬性} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

CassandraTableCreateUpdatePropertiesOrCassandraTable...

名稱 描述
選項 要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。 CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...
資源 Cassandra 數據表的標準 JSON 格式 CassandraTableResourceOrCassandraTableGetPropertiesR... 必要 ()

CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...

名稱 描述
autoscaleSettings 指定自動調整設定。 AutoscaleSettings
輸送量 每秒要求單位數。 例如,「輸送量」:10000。 int

AutoscaleSettings

名稱 描述
maxThroughput 代表最大輸送量,資源可以相應增加為 。 int

CassandraTableResourceOrCassandraTableGetPropertiesR...

名稱 描述
分析StorageTtl 分析TTL。 int
defaultTtl Cosmos DB Cassandra 數據表的生存時間 int
id Cosmos DB Cassandra 數據表的名稱 需要字串 ()
結構描述 Cosmos DB Cassandra 數據表的架構 CassandraSchema

CassandraSchema

名稱 描述
clusterKeys 叢集金鑰清單。 ClusterKey[]
資料行 Cassandra 資料表數據行的清單。 Column[]
partitionKeys 數據分割索引鍵的清單。 CassandraPartitionKey[]

ClusterKey

名稱 描述
NAME Cosmos DB Cassandra 數據表叢集金鑰的名稱 字串
orderBy Cosmos DB Cassandra 數據表叢集索引鍵的順序,僅支援 “Asc” 和 “Desc” 字串

Column

名稱 描述
NAME Cosmos DB Cassandra 資料表數據行的名稱 字串
type Cosmos DB Cassandra 資料表數據行的類型 字串

CassandraPartitionKey

名稱 描述
NAME Cosmos DB Cassandra 數據表分割索引鍵的名稱 字串

快速入門範本

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

範本 描述
建立適用於 Cassandra API 的 Azure Cosmos DB 帳戶

部署至 Azure
此範本會在兩個區域中建立 Cassandra API 的 Azure Cosmos DB 帳戶,其中包含 keyspace 和具有專用輸送量的數據表。
建立 Cassandra API 的自動調整 Azure Cosmos DB 帳戶

部署至 Azure
此範本會在兩個區域中建立 Cassandra API 的 Azure Cosmos DB 帳戶,其中包含 keyspace 和具有自動調整輸送量的數據表。

ARM 範本資源定義

databaseAccounts/cassandraKeyspaces/tables 資源類型可以使用目標作業來部署:

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

資源格式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables",
  "apiVersion": "2022-02-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "defaultTtl": "int",
      "id": "string",
      "schema": {
        "clusterKeys": [
          {
            "name": "string",
            "orderBy": "string"
          }
        ],
        "columns": [
          {
            "name": "string",
            "type": "string"
          }
        ],
        "partitionKeys": [
          {
            "name": "string"
          }
        ]
      }
    }
  }
}

屬性值

databaseAccounts/cassandraKeyspaces/tables

名稱 描述
類型 資源類型 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables'
apiVersion 資源 API 版本 '2022-02-15-preview'
NAME 資源名稱

瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。
需要字串 ()
location 資源所屬之資源群組的位置。 字串
tags 標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源,以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元,值則不得多於 256 個字元。 例如,範本類型的默認體驗會設定為 「defaultExperience」:“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 標記名稱和值的字典。 請參閱 範本中的標籤
身分識別 資源的身分識別。 ManagedServiceIdentity
properties 用來建立和更新 Azure Cosmos DB Cassandra 數據表的屬性。 CassandraTableCreateUpdatePropertiesOrCassandraTable... 必要 ()

ManagedServiceIdentity

名稱 描述
類型 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned':用於資源的身分識別類型。 類型 'SystemAssigned,UserAssigned' 同時包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。
userAssignedIdentities 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名稱 描述
{自定義屬性} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

CassandraTableCreateUpdatePropertiesOrCassandraTable...

名稱 描述
選項 要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。 CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...
資源 Cassandra 數據表的標準 JSON 格式 CassandraTableResourceOrCassandraTableGetPropertiesR... 必要 ()

CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...

名稱 描述
autoscaleSettings 指定自動調整設定。 AutoscaleSettings
輸送量 每秒要求單位數。 例如,「輸送量」:10000。 int

AutoscaleSettings

名稱 描述
maxThroughput 代表最大輸送量,資源可以相應增加為 。 int

CassandraTableResourceOrCassandraTableGetPropertiesR...

名稱 描述
分析StorageTtl 分析TTL。 int
defaultTtl Cosmos DB Cassandra 數據表的生存時間 int
id Cosmos DB Cassandra 數據表的名稱 需要字串 ()
結構描述 Cosmos DB Cassandra 數據表的架構 CassandraSchema

CassandraSchema

名稱 描述
clusterKeys 叢集金鑰清單。 ClusterKey[]
資料行 Cassandra 資料表數據行的清單。 Column[]
partitionKeys 數據分割索引鍵的清單。 CassandraPartitionKey[]

ClusterKey

名稱 描述
NAME Cosmos DB Cassandra 數據表叢集金鑰的名稱 字串
orderBy Cosmos DB Cassandra 數據表叢集索引鍵的順序,僅支援 “Asc” 和 “Desc” 字串

Column

名稱 描述
NAME Cosmos DB Cassandra 資料表數據行的名稱 字串
type Cosmos DB Cassandra 資料表數據行的類型 字串

CassandraPartitionKey

名稱 描述
NAME Cosmos DB Cassandra 數據表分割索引鍵的名稱 字串

快速入門範本

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

範本 描述
建立適用於 Cassandra API 的 Azure Cosmos DB 帳戶

部署至 Azure
此範本會在兩個區域中建立 Cassandra API 的 Azure Cosmos DB 帳戶,其中包含 keyspace 和具有專用輸送量的數據表。
建立 Cassandra API 的自動調整 Azure Cosmos DB 帳戶

部署至 Azure
此範本會在兩個區域中建立 Cassandra API 的 Azure Cosmos DB 帳戶,其中包含 keyspace 和具有自動調整輸送量的數據表。

Terraform (AzAPI 提供者) 資源定義

databaseAccounts/cassandraKeyspaces/tables 資源類型可以使用目標作業來部署:

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2022-02-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        defaultTtl = int
        id = "string"
        schema = {
          clusterKeys = [
            {
              name = "string"
              orderBy = "string"
            }
          ]
          columns = [
            {
              name = "string"
              type = "string"
            }
          ]
          partitionKeys = [
            {
              name = "string"
            }
          ]
        }
      }
    }
  })
}

屬性值

databaseAccounts/cassandraKeyspaces/tables

名稱 描述
類型 資源類型 “Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2022-02-15-preview”
NAME 資源名稱 需要字串 ()
location 資源所屬之資源群組的位置。 字串
parent_id 此資源父系之資源的標識碼。 類型資源的標識碼: cassandraKeyspaces
tags 標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源,以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元,值則不得多於 256 個字元。 例如,範本類型的默認體驗會設定為 「defaultExperience」:“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 標記名稱和值的字典。
身分識別 資源的身分識別。 ManagedServiceIdentity
properties 用來建立和更新 Azure Cosmos DB Cassandra 數據表的屬性。 CassandraTableCreateUpdatePropertiesOrCassandraTable... 必要 ()

ManagedServiceIdentity

名稱 描述
類型 “SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”:用於資源的身分識別類型。 類型 「SystemAssigned,UserAssigned」 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 「None」 會從服務中移除任何身分識別。
identity_ids 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 使用者身分識別標識碼的陣列。

ManagedServiceIdentityUserAssignedIdentities

名稱 描述
{自定義屬性} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

CassandraTableCreateUpdatePropertiesOrCassandraTable...

名稱 描述
選項 要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。 CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...
資源 Cassandra 數據表的標準 JSON 格式 CassandraTableResourceOrCassandraTableGetPropertiesR... 必要 ()

CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...

名稱 描述
autoscaleSettings 指定自動調整設定。 AutoscaleSettings
輸送量 每秒要求單位數。 例如,「輸送量」:10000。 int

AutoscaleSettings

名稱 描述
maxThroughput 代表最大輸送量,資源可以相應增加為 。 int

CassandraTableResourceOrCassandraTableGetPropertiesR...

名稱 描述
分析StorageTtl 分析TTL。 int
defaultTtl Cosmos DB Cassandra 數據表的生存時間 int
id Cosmos DB Cassandra 數據表的名稱 需要字串 ()
結構描述 Cosmos DB Cassandra 數據表的架構 CassandraSchema

CassandraSchema

名稱 描述
clusterKeys 叢集金鑰清單。 ClusterKey[]
資料行 Cassandra 資料表數據行的清單。 Column[]
partitionKeys 數據分割索引鍵的清單。 CassandraPartitionKey[]

ClusterKey

名稱 描述
NAME Cosmos DB Cassandra 數據表叢集金鑰的名稱 字串
orderBy Cosmos DB Cassandra 數據表叢集索引鍵的順序,僅支援 “Asc” 和 “Desc” 字串

Column

名稱 描述
NAME Cosmos DB Cassandra 資料表數據行的名稱 字串
type Cosmos DB Cassandra 資料表數據行的類型 字串

CassandraPartitionKey

名稱 描述
NAME Cosmos DB Cassandra 數據表分割索引鍵的名稱 字串