DatabaseAccountCreateUpdateParameters interface
用于创建和更新 Cosmos DB 数据库帐户的参数。
属性
| analytical |
分析存储特定属性。 |
| api |
API 特定属性。 目前，仅 MongoDB API 支持。 |
| backup |
表示用于在帐户上备份的策略的对象。 |
| capabilities | 帐户的 Cosmos DB 功能列表 |
| capacity | 表示与帐户上的容量强制实施相关的所有属性的对象。 |
| connector |
cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。 |
| consistency |
Cosmos DB 帐户的一致性策略。 |
| cors | Cosmos DB 数据库帐户的 CORS 策略。 |
| create |
枚举以指示帐户创建模式。 |
| customer |
指示帐户上客户管理的密钥功能的状态。 如果出现错误，该属性将提供故障排除指南。 |
| database |
数据库的套餐类型 |
| default |
用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 用户需要显式设置默认标识。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。 |
| default |
枚举以指示基于优先级的执行的默认优先级请求级别。 |
| disable |
通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作 |
| disable |
选择退出本地身份验证，并确保只能将 MSI 和 AAD 用于身份验证。 |
| enable |
用于指示是否启用存储分析的标志。 |
| enable |
在极少数情况下启用写入区域的自动故障转移，因为服务中断导致该区域不可用。 自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。 |
| enable |
指示在帐户上启用/禁用突发容量功能的标志 |
| enable |
在 Cosmos DB C* 帐户上启用 cassandra 连接器 |
| enable |
用于指示是否启用免费层的标志。 |
| enable |
使帐户能够在多个位置写入 |
| enable |
用于指示在帐户上启用/禁用分区合并功能的标志 |
| enable |
用于指示在帐户上启用/禁用 PerRegionPerPartitionAutoscale 功能的标志 |
| enable |
指示在帐户上启用/禁用基于优先级的执行预览功能的标志 |
| identity | 资源的标识。 |
| ip |
IpRules 列表。 |
| is |
用于指示是否启用/禁用虚拟网络 ACL 规则的标志。 |
| keys |
在更新/创建操作期间忽略此属性，因为元数据是只读的。 该对象表示 Cosmos DB 帐户的帐户密钥的元数据。 注意：此属性不会序列化。 它只能由服务器填充。 |
| key |
密钥保管库的 URI |
| kind | 指示数据库帐户的类型。 只能在创建数据库帐户时设置此设置。 |
| locations | 一个数组，其中包含为 Cosmos DB 帐户启用的地理复制位置。 |
| minimal |
指示允许的最低 Tls 版本。 默认值为 Tls 1.2。 Cassandra 和 Mongo API 仅适用于 Tls 1.2。 |
| network |
指示允许哪些服务绕过防火墙检查。 |
| network |
一个数组，其中包含 Cosmos DB 帐户的网络 Acl 绕过的资源 ID。 |
| public |
是否允许来自公用网络的请求 |
| restore |
用于指示还原信息的参数。 |
| virtual |
为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。 |
继承属性
| id | ARM 资源的唯一资源标识符。 注意：此属性不会序列化。 它只能由服务器填充。 |
| location | 资源所属的资源组的位置。 |
| name | ARM 资源的名称。 注意：此属性不会序列化。 它只能由服务器填充。 |
| tags | 标记是描述资源的键值对的列表。 这些标记可用于查看和分组此资源（跨资源组）。 最多可为资源提供 15 个标记。 每个标记必须具有不超过 128 个字符的键，且值不超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 |
| type | Azure 资源的类型。 注意：此属性不会序列化。 它只能由服务器填充。 |
属性详细信息
analyticalStorageConfiguration
分析存储特定属性。
analyticalStorageConfiguration?: AnalyticalStorageConfiguration属性值
apiProperties
backupPolicy
capabilities
capacity
connectorOffer
cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。
connectorOffer?: string属性值
string
consistencyPolicy
cors
createMode
枚举以指示帐户创建模式。
createMode?: string属性值
string
customerManagedKeyStatus
指示帐户上客户管理的密钥功能的状态。 如果出现错误，该属性将提供故障排除指南。
customerManagedKeyStatus?: string属性值
string
databaseAccountOfferType
数据库的套餐类型
databaseAccountOfferType: "Standard"属性值
"Standard"
defaultIdentity
用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 用户需要显式设置默认标识。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。
defaultIdentity?: string属性值
string
defaultPriorityLevel
枚举以指示基于优先级的执行的默认优先级请求级别。
defaultPriorityLevel?: string属性值
string
disableKeyBasedMetadataWriteAccess
通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作
disableKeyBasedMetadataWriteAccess?: boolean属性值
boolean
disableLocalAuth
选择退出本地身份验证，并确保只能将 MSI 和 AAD 用于身份验证。
disableLocalAuth?: boolean属性值
boolean
enableAnalyticalStorage
用于指示是否启用存储分析的标志。
enableAnalyticalStorage?: boolean属性值
boolean
enableAutomaticFailover
在极少数情况下启用写入区域的自动故障转移，因为服务中断导致该区域不可用。 自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。
enableAutomaticFailover?: boolean属性值
boolean
enableBurstCapacity
指示在帐户上启用/禁用突发容量功能的标志
enableBurstCapacity?: boolean属性值
boolean
enableCassandraConnector
在 Cosmos DB C* 帐户上启用 cassandra 连接器
enableCassandraConnector?: boolean属性值
boolean
enableFreeTier
用于指示是否启用免费层的标志。
enableFreeTier?: boolean属性值
boolean
enableMultipleWriteLocations
使帐户能够在多个位置写入
enableMultipleWriteLocations?: boolean属性值
boolean
enablePartitionMerge
用于指示在帐户上启用/禁用分区合并功能的标志
enablePartitionMerge?: boolean属性值
boolean
enablePerRegionPerPartitionAutoscale
用于指示在帐户上启用/禁用 PerRegionPerPartitionAutoscale 功能的标志
enablePerRegionPerPartitionAutoscale?: boolean属性值
boolean
enablePriorityBasedExecution
指示在帐户上启用/禁用基于优先级的执行预览功能的标志
enablePriorityBasedExecution?: boolean属性值
boolean
identity
ipRules
isVirtualNetworkFilterEnabled
用于指示是否启用/禁用虚拟网络 ACL 规则的标志。
isVirtualNetworkFilterEnabled?: boolean属性值
boolean
keysMetadata
在更新/创建操作期间忽略此属性，因为元数据是只读的。 该对象表示 Cosmos DB 帐户的帐户密钥的元数据。 注意：此属性不会序列化。 它只能由服务器填充。
keysMetadata?: DatabaseAccountKeysMetadata属性值
keyVaultKeyUri
密钥保管库的 URI
keyVaultKeyUri?: string属性值
string
kind
指示数据库帐户的类型。 只能在创建数据库帐户时设置此设置。
kind?: string属性值
string
locations
minimalTlsVersion
指示允许的最低 Tls 版本。 默认值为 Tls 1.2。 Cassandra 和 Mongo API 仅适用于 Tls 1.2。
minimalTlsVersion?: string属性值
string
networkAclBypass
networkAclBypassResourceIds
一个数组，其中包含 Cosmos DB 帐户的网络 Acl 绕过的资源 ID。
networkAclBypassResourceIds?: string[]属性值
string[]
publicNetworkAccess
是否允许来自公用网络的请求
publicNetworkAccess?: string属性值
string
restoreParameters
virtualNetworkRules
继承属性详细信息
id
ARM 资源的唯一资源标识符。 注意：此属性不会序列化。 它只能由服务器填充。
id?: string属性值
string
继承自
location
name
ARM 资源的名称。 注意：此属性不会序列化。 它只能由服务器填充。
name?: string属性值
string
继承自
tags
标记是描述资源的键值对的列表。 这些标记可用于查看和分组此资源（跨资源组）。 最多可为资源提供 15 个标记。 每个标记必须具有不超过 128 个字符的键，且值不超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。
tags?: {[propertyName: string]: string}属性值
{[propertyName: string]: string}