你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

DatabaseAccountCreateUpdateParameters interface

用于创建和更新 Cosmos DB 数据库帐户的参数。

扩展

属性

analyticalStorageConfiguration

分析存储特定属性。

apiProperties

API 特定属性。 目前,仅 MongoDB API 支持。

backupPolicy

表示用于在帐户上备份的策略的对象。

capabilities

帐户的 Cosmos DB 功能列表

capacity

表示与帐户上的容量强制实施相关的所有属性的对象。

connectorOffer

cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。

consistencyPolicy

Cosmos DB 帐户的一致性策略。

cors

Cosmos DB 数据库帐户的 CORS 策略。

createMode

枚举以指示帐户创建模式。

customerManagedKeyStatus

指示帐户上客户管理的密钥功能的状态。 如果出现错误,该属性将提供故障排除指南。

databaseAccountOfferType

数据库的套餐类型

defaultIdentity

用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 用户需要显式设置默认标识。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。

disableKeyBasedMetadataWriteAccess

通过帐户密钥对元数据资源(数据库、容器、吞吐量)禁用写入操作

disableLocalAuth

选择退出本地身份验证,并确保只能将 MSI 和 AAD 用于身份验证。

enableAnalyticalStorage

用于指示是否启用存储分析的标志。

enableAutomaticFailover

在极少数情况下启用写入区域的自动故障转移,因为服务中断导致该区域不可用。 自动故障转移将导致帐户的新写入区域,并根据为帐户配置的故障转移优先级进行选择。

enableBurstCapacity

指示在帐户上启用/禁用突发容量功能的标志

enableCassandraConnector

在 Cosmos DB C* 帐户上启用 cassandra 连接器

enableFreeTier

用于指示是否启用免费层的标志。

enableMultipleWriteLocations

使帐户能够在多个位置写入

enablePartitionMerge

用于指示在帐户上启用/禁用分区合并功能的标志

enablePerRegionPerPartitionAutoscale

用于指示在帐户上启用/禁用 PerRegionPerPartitionAutoscale 功能的标志

identity

资源的标识。

ipRules

IpRules 列表。

isVirtualNetworkFilterEnabled

用于指示是否启用/禁用虚拟网络 ACL 规则的标志。

keysMetadata

在更新/创建操作期间忽略此属性,因为元数据是只读的。 该对象表示 Cosmos DB 帐户的帐户密钥的元数据。 注意:此属性不会序列化。 它只能由服务器填充。

keyVaultKeyUri

密钥保管库的 URI

kind

指示数据库帐户的类型。 只能在创建数据库帐户时设置此设置。

locations

一个数组,其中包含为 Cosmos DB 帐户启用的地理复制位置。

minimalTlsVersion

指示允许的最低 Tls 版本。 默认值为 Tls 1.2。 Cassandra 和 Mongo API 仅适用于 Tls 1.2。

networkAclBypass

指示允许哪些服务绕过防火墙检查。

networkAclBypassResourceIds

一个数组,其中包含 Cosmos DB 帐户的网络 Acl 绕过的资源 ID。

publicNetworkAccess

是否允许来自公用网络的请求

restoreParameters

用于指示还原信息的参数。

virtualNetworkRules

为 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

API 特定属性。 目前,仅 MongoDB API 支持。

apiProperties?: ApiProperties

属性值

backupPolicy

表示用于在帐户上备份的策略的对象。

backupPolicy?: BackupPolicyUnion

属性值

capabilities

帐户的 Cosmos DB 功能列表

capabilities?: Capability[]

属性值

capacity

表示与帐户上的容量强制实施相关的所有属性的对象。

capacity?: Capacity

属性值

connectorOffer

cassandra 连接器为 Cosmos DB 数据库 C* 帐户提供类型。

connectorOffer?: string

属性值

string

consistencyPolicy

Cosmos DB 帐户的一致性策略。

consistencyPolicy?: ConsistencyPolicy

属性值

cors

Cosmos DB 数据库帐户的 CORS 策略。

cors?: CorsPolicy[]

属性值

createMode

枚举以指示帐户创建模式。

createMode?: string

属性值

string

customerManagedKeyStatus

指示帐户上客户管理的密钥功能的状态。 如果出现错误,该属性将提供故障排除指南。

customerManagedKeyStatus?: string

属性值

string

databaseAccountOfferType

数据库的套餐类型

databaseAccountOfferType: "Standard"

属性值

"Standard"

defaultIdentity

用于访问客户托管密钥等功能中使用的密钥保管库的默认标识。 用户需要显式设置默认标识。 它可以是“FirstPartyIdentity”、“SystemAssignedIdentity”等。

defaultIdentity?: 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

identity

资源的标识。

identity?: ManagedServiceIdentity

属性值

ipRules

IpRules 列表。

ipRules?: IpAddressOrRange[]

属性值

isVirtualNetworkFilterEnabled

用于指示是否启用/禁用虚拟网络 ACL 规则的标志。

isVirtualNetworkFilterEnabled?: boolean

属性值

boolean

keysMetadata

在更新/创建操作期间忽略此属性,因为元数据是只读的。 该对象表示 Cosmos DB 帐户的帐户密钥的元数据。 注意:此属性不会序列化。 它只能由服务器填充。

keysMetadata?: DatabaseAccountKeysMetadata

属性值

keyVaultKeyUri

密钥保管库的 URI

keyVaultKeyUri?: string

属性值

string

kind

指示数据库帐户的类型。 只能在创建数据库帐户时设置此设置。

kind?: string

属性值

string

locations

一个数组,其中包含为 Cosmos DB 帐户启用的地理复制位置。

locations: Location[]

属性值

minimalTlsVersion

指示允许的最低 Tls 版本。 默认值为 Tls 1.2。 Cassandra 和 Mongo API 仅适用于 Tls 1.2。

minimalTlsVersion?: string

属性值

string

networkAclBypass

指示允许哪些服务绕过防火墙检查。

networkAclBypass?: NetworkAclBypass

属性值

networkAclBypassResourceIds

一个数组,其中包含 Cosmos DB 帐户的网络 Acl 绕过的资源 ID。

networkAclBypassResourceIds?: string[]

属性值

string[]

publicNetworkAccess

是否允许来自公用网络的请求

publicNetworkAccess?: string

属性值

string

restoreParameters

用于指示还原信息的参数。

restoreParameters?: RestoreParameters

属性值

virtualNetworkRules

为 Cosmos DB 帐户配置的虚拟网络 ACL 规则列表。

virtualNetworkRules?: VirtualNetworkRule[]

属性值

继承属性详细信息

id

ARM 资源的唯一资源标识符。 注意:此属性不会序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自ARMResourceProperties.id

location

资源所属的资源组的位置。

location?: string

属性值

string

继承自ARMResourceProperties.location

name

ARM 资源的名称。 注意:此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自ARMResourceProperties.name

tags

标记是描述资源的键值对的列表。 这些标记可用于查看和分组此资源(跨资源组)。 最多可为资源提供 15 个标记。 每个标记必须具有不超过 128 个字符的键,且值不超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。

tags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自ARMResourceProperties.tags

type

Azure 资源的类型。 注意:此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自ARMResourceProperties.type