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

Azure.ResourceManager.CosmosDB.Models 命名空间

参考

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

类

ArmCosmosDBModelFactory	模型的模型工厂。
AuthenticationMethodLdapProperties	Ldap 身份验证方法属性。此功能为预览版。
AutoscaleSettingsResourceInfo	Cosmos DB 预配的吞吐量设置对象。
AzureBlobDataTransferDataSourceSink	Azure Blob 存储数据源/接收器。
BackupPolicyMigrationState	表示备份策略之间迁移状态的对象。
CassandraCertificate	CassandraCertificate。
CassandraClusterBackupResourceInfo	Cassandra 群集的可还原备份。
CassandraClusterBackupSchedule	CassandraClusterBackupSchedule。
CassandraClusterDataCenterNodeItem	CassandraClusterDataCenterNodeItem。
CassandraClusterKey	Cosmos DB Cassandra 表群集密钥。
CassandraClusterProperties	托管 Cassandra 群集的属性。
CassandraClusterPublicStatus	托管 Cassandra 群集公共状态的属性。
CassandraClusterPublicStatusDataCentersItem	CassandraClusterPublicStatusDataCentersItem。
CassandraColumn	Cosmos DB Cassandra 表列。
CassandraCommandOutput	/command api 的响应。
CassandraCommandPostBody	指定在何处运行的命令。
CassandraConnectionError	CassandraConnectionError。
CassandraDataCenterProperties	托管 Cassandra 数据中心的属性。
CassandraDataCenterSeedNode	CassandraDataCenterSeedNode。
CassandraError	CassandraError。
CassandraKeyspaceCreateOrUpdateContent	用于创建和更新 Cosmos DB Cassandra 密钥空间的参数。
CassandraKeyspacePropertiesConfig	CassandraKeyspacePropertiesConfig。
CassandraKeyspaceResourceInfo	Cosmos DB Cassandra keyspace 资源对象。
CassandraPartitionKey	Cosmos DB Cassandra 表分区键。
CassandraReaperStatus	CassandraReaperStatus。
CassandraSchema	Cosmos DB Cassandra 表架构。
CassandraTableCreateOrUpdateContent	用于创建和更新 Cosmos DB Cassandra 表的参数。
CassandraTablePropertiesConfig	CassandraTablePropertiesConfig。
CassandraTableResourceInfo	Cosmos DB Cassandra 表资源对象。
CassandraViewGetPropertiesOptions	CassandraViewGetPropertiesOptions。
CassandraViewGetPropertiesResource	CassandraViewGetPropertiesResource。
CassandraViewGetResultCreateOrUpdateContent	用于创建和更新 Cosmos DB Cassandra 视图的参数。
CassandraViewResource	Cosmos DB Cassandra 视图资源对象。
CheckCosmosDBNameAvailabilityContent	检查可用性请求正文。
CheckCosmosDBNameAvailabilityResponse	检查可用性结果。
ConflictResolutionPolicy	容器的冲突解决策略。
ConsistencyPolicy	Cosmos DB 数据库帐户的一致性策略。
ContinuousBackupRestoreLocation	区域可还原帐户的属性。
ContinuousModeBackupPolicy	表示连续模式备份策略的对象。
CosmosCassandraDataTransferDataSourceSink	CosmosDB Cassandra API 数据源/接收器。
CosmosDBAccountBackupPolicy	表示在帐户上进行备份的策略的对象。请注意 CosmosDBAccountBackupPolicy ，是基类。根据方案，可能需要在此处分配基类的派生类，或者此属性需要强制转换为可能的派生类之一。可用的派生类包括 ContinuousModeBackupPolicy 和 PeriodicModeBackupPolicy。
CosmosDBAccountCapability	Cosmos DB 功能对象。
CosmosDBAccountConnectionString	Cosmos DB 帐户的连接字符串。
CosmosDBAccountCorsPolicy	Cosmos DB 数据库帐户的 CORS 策略。
CosmosDBAccountCreateOrUpdateContent	用于创建和更新 Cosmos DB 数据库帐户的参数。
CosmosDBAccountKeyList	给定数据库帐户的访问密钥。
CosmosDBAccountLocation	在其中部署 Azure Cosmos DB 数据库帐户的区域。
CosmosDBAccountPatch	用于修补 Azure Cosmos DB 数据库帐户属性的参数。
CosmosDBAccountReadOnlyKeyList	给定数据库帐户的只读访问密钥。
CosmosDBAccountRegenerateKeyContent	用于在数据库帐户中重新生成密钥的参数。
CosmosDBAccountRestoreParameters	指示有关还原的信息的参数。
CosmosDBBackupInformation	资源的备份信息。
CosmosDBBaseConfig	Cosmos DB 选项资源对象。
CosmosDBBaseMetric	指标数据。
CosmosDBBaseUsage	使用情况请求的使用情况数据。
CosmosDBClientEncryptionIncludedPath	.
CosmosDBClientEncryptionPolicy	Cosmos DB 客户端加密策略。
CosmosDBCompositePath	CosmosDBCompositePath。
CosmosDBConnectionString	mongo 群集的连接字符串。
CosmosDBContainerPartitionKey	用于将数据分区到多个分区的分区键的配置。
CosmosDBCreateUpdateConfig	CreateUpdateOptions 是描述资源的键值对的列表。支持的密钥为“If-Match”、“If-None-Match”、“Session-Token”和“Throughput”。
CosmosDBExcludedPath	CosmosDBExcludedPath。
CosmosDBFailoverPolicies	故障转移优先级更改的新故障转移策略列表。
CosmosDBFailoverPolicy	数据库帐户给定区域的故障转移策略。
CosmosDBIncludedPath	索引中包含的路径。
CosmosDBIndexingPolicy	Cosmos DB 索引策略。
CosmosDBIPAddressOrRange	IpAddressOrRange 对象。
CosmosDBKeyWrapMetadata	表示密钥包装提供程序可用于包装/解包客户端加密密钥的密钥包装元数据。
CosmosDBLocationProperties	Cosmos DB 位置元数据。
CosmosDBMetricAvailability	指标的可用性。
CosmosDBMetricDefinition	指标的定义。
CosmosDBMetricName	指标名称。
CosmosDBMetricValue	表示指标值。
CosmosDBPathIndexes	路径的索引。
CosmosDBPercentileMetric	百分位数指标数据。
CosmosDBPrivateLinkServiceConnectionStateProperty	专用终结点连接的连接状态。
CosmosDBRegionalService	区域服务位置的资源。
CosmosDBServiceCreateOrUpdateContent	创建或更新 ServiceResource 请求的参数。
CosmosDBServiceProperties	服务响应资源。请注意 CosmosDBServiceProperties ，是基类。根据方案，可能需要在此处分配基类的派生类，或者此属性需要强制转换为可能的派生类之一。可用的派生类包括 DataTransferServiceProperties、 GraphApiComputeServiceProperties MaterializedViewsBuilderServiceProperties 和 SqlDedicatedGatewayServiceProperties。
CosmosDBSqlClientEncryptionKeyCreateOrUpdateContent	用于创建和更新 ClientEncryptionKey 的参数。
CosmosDBSqlClientEncryptionKeyProperties	CosmosDBSqlClientEncryptionKeyProperties。
CosmosDBSqlClientEncryptionKeyResourceInfo	Cosmos DB 客户端加密密钥资源对象。
CosmosDBSqlContainerCreateOrUpdateContent	用于创建和更新 Cosmos DB 容器的参数。
CosmosDBSqlContainerPropertiesConfig	CosmosDBSqlContainerPropertiesConfig。
CosmosDBSqlContainerResourceInfo	Cosmos DB SQL 容器资源对象。
CosmosDBSqlDatabaseCreateOrUpdateContent	用于创建和更新 Cosmos DB SQL 数据库的参数。
CosmosDBSqlDatabasePropertiesConfig	CosmosDBSqlDatabasePropertiesConfig。
CosmosDBSqlDatabaseResourceInfo	Cosmos DB SQL 数据库资源对象。
CosmosDBSqlRoleAssignmentCreateOrUpdateContent	用于创建和更新 Azure Cosmos DB SQL 角色分配的参数。
CosmosDBSqlRoleDefinitionCreateOrUpdateContent	用于创建和更新 Azure Cosmos DB SQL 角色定义的参数。
CosmosDBSqlRolePermission	通过此角色定义允许的数据平面操作集。
CosmosDBSqlStoredProcedureCreateOrUpdateContent	用于创建和更新 Cosmos DB storedProcedure 的参数。
CosmosDBSqlStoredProcedureResourceInfo	Cosmos DB SQL storedProcedure 资源对象。
CosmosDBSqlTriggerCreateOrUpdateContent	用于创建和更新 Cosmos DB 触发器的参数。
CosmosDBSqlTriggerResourceInfo	Cosmos DB SQL 触发器资源对象。
CosmosDBSqlUserDefinedFunctionCreateOrUpdateContent	用于创建和更新 Cosmos DB userDefinedFunction 的参数。
CosmosDBSqlUserDefinedFunctionResourceInfo	Cosmos DB SQL userDefinedFunction 资源对象。
CosmosDBTableCreateOrUpdateContent	用于创建和更新 Cosmos DB 表的参数。
CosmosDBTablePropertiesOptions	CosmosDBTablePropertiesOptions。
CosmosDBTablePropertiesResource	CosmosDBTablePropertiesResource。
CosmosDBTableResourceInfo	Cosmos DB 表资源对象。
CosmosDBUniqueKey	上的唯一键，对 Azure Cosmos DB 服务中的集合中的文档强制实施唯一性约束。
CosmosDBVirtualNetworkRule	虚拟网络 ACL Rule 对象。
CosmosMongoDataTransferDataSourceSink	CosmosDB Mongo API 数据源/接收器。
CosmosSqlDataTransferDataSourceSink	CosmosDB 无 Sql API 数据源/接收器。
DatabaseAccountKeysMetadata	与给定 Cosmos DB 数据库帐户的每个访问密钥相关的元数据。
DatabaseRestoreResourceInfo	要还原的特定数据库。
DataTransferDataSourceSink	所有 DataTransfer 源/接收器的基类请注意 DataTransferDataSourceSink 是基类。根据方案，可能需要在此处分配基类的派生类，或者此属性需要强制转换为可能的派生类之一。可用的派生类包括 AzureBlobDataTransferDataSourceSink、 CosmosCassandraDataTransferDataSourceSink CosmosMongoDataTransferDataSourceSink 和 CosmosSqlDataTransferDataSourceSink。
DataTransferJobGetResultCreateOrUpdateContent	用于创建数据传输作业的参数。
DataTransferJobProperties	DataTransfer 作业的属性。
DataTransferRegionalService	区域服务位置的资源。
DataTransferServiceProperties	DataTransferServiceResource 的属性。
ErrorResponse	错误响应。
ExtendedCassandraKeyspaceResourceInfo	ExtendedCassandraKeyspaceResourceInfo。
ExtendedCassandraTableResourceInfo	ExtendedCassandraTableResourceInfo。
ExtendedCosmosDBSqlContainerResourceInfo	ExtendedCosmosDBSqlContainerResourceInfo。
ExtendedCosmosDBSqlDatabaseResourceInfo	ExtendedCosmosDBSqlDatabaseResourceInfo。
ExtendedCosmosDBSqlStoredProcedureResourceInfo	ExtendedCosmosDBSqlStoredProcedureResourceInfo。
ExtendedCosmosDBSqlTriggerResourceInfo	ExtendedCosmosDBSqlTriggerResourceInfo。
ExtendedCosmosDBSqlUserDefinedFunctionResourceInfo	ExtendedCosmosDBSqlUserDefinedFunctionResourceInfo。
ExtendedGremlinDatabaseResourceInfo	ExtendedGremlinDatabaseResourceInfo。
ExtendedGremlinGraphResourceInfo	ExtendedGremlinGraphResourceInfo。
ExtendedMongoDBCollectionResourceInfo	ExtendedMongoDBCollectionResourceInfo。
ExtendedMongoDBDatabaseResourceInfo	ExtendedMongoDBDatabaseResourceInfo。
ExtendedRestorableGremlinDatabaseResourceInfo	Azure Cosmos DB Gremlin 数据库事件的资源。
ExtendedRestorableGremlinGraphResourceInfo	Azure Cosmos DB Gremlin 图形事件的资源。
ExtendedRestorableMongoDBCollectionResourceInfo	Azure Cosmos DB MongoDB 集合事件的资源。
ExtendedRestorableMongoDBDatabaseResourceInfo	Azure Cosmos DB MongoDB 数据库事件的资源。
ExtendedRestorableSqlContainerResourceInfo	Azure Cosmos DB SQL 容器事件的资源。
ExtendedRestorableSqlDatabaseResourceInfo	Azure Cosmos DB SQL 数据库事件的资源。
ExtendedRestorableTableResourceInfo	Azure Cosmos DB 表事件的资源。
ExtendedThroughputSettingsResourceInfo	ExtendedThroughputSettingsResourceInfo。
GraphApiComputeRegionalService	区域服务位置的资源。
GraphApiComputeServiceProperties	GraphAPIComputeServiceResource 的属性。
GraphResourceGetPropertiesOptions	GraphResourceGetPropertiesOptions。
GraphResourceGetResultCreateOrUpdateContent	用于创建和更新 Cosmos DB Graph 资源的参数。
GremlinDatabaseCreateOrUpdateContent	用于创建和更新 Cosmos DB Gremlin 数据库的参数。
GremlinDatabasePropertiesConfig	GremlinDatabasePropertiesConfig。
GremlinDatabaseResourceInfo	Cosmos DB Gremlin 数据库资源对象。
GremlinDatabaseRestoreResourceInfo	要还原的特定 Gremlin 数据库。
GremlinGraphCreateOrUpdateContent	用于创建和更新 Cosmos DB Gremlin 图的参数。
GremlinGraphPropertiesConfig	GremlinGraphPropertiesConfig。
GremlinGraphResourceInfo	Cosmos DB Gremlin 图形资源对象。
ListConnectionStringsResult	给定 mongo 群集的连接字符串。
MaterializedViewDefinition	容器的具体化视图定义。
MaterializedViewsBuilderRegionalService	区域服务位置的资源。
MaterializedViewsBuilderServiceProperties	MaterializedViewsBuilderServiceResource 的属性。
MergeParameters	Azure Cosmos DB 合并操作的属性。
MongoClusterPatch	表示用于更新的 mongo 群集资源。
MongoClusterRestoreParameters	用于还原操作的参数。
MongoDBCollectionCreateOrUpdateContent	用于创建和更新 Cosmos DB MongoDB 集合的参数。
MongoDBCollectionPropertiesConfig	MongoDBCollectionPropertiesConfig。
MongoDBCollectionResourceInfo	Cosmos DB MongoDB 集合资源对象。
MongoDBDatabaseCreateOrUpdateContent	用于创建和更新 Cosmos DB MongoDB 数据库的参数。
MongoDBDatabasePropertiesConfig	MongoDBDatabasePropertiesConfig。
MongoDBDatabaseResourceInfo	Cosmos DB MongoDB 数据库资源对象。
MongoDBIndex	Cosmos DB MongoDB 集合索引键。
MongoDBIndexConfig	Cosmos DB MongoDB 集合索引选项。
MongoDBPrivilege	通过此角色定义允许的数据平面操作集。
MongoDBPrivilegeResourceInfo	Azure Cosmos DB Mongo DB 资源。
MongoDBRole	通过此角色定义允许的角色集。
MongoDBRoleDefinitionCreateOrUpdateContent	用于创建和更新 Azure Cosmos DB Mongo 角色定义的参数。
MongoDBUserDefinitionCreateOrUpdateContent	用于创建和更新 Azure Cosmos DB Mongo 用户定义的参数。
NodeGroupProperties	群集上节点组的属性。
NodeGroupSpec	节点组的规范。
PartitionMetric	单个分区的指标值。
PartitionUsage	使用情况请求的分区级别使用情况数据。
PercentileMetricValue	表示百分位指标值。
PeriodicModeBackupPolicy	表示定期模式备份策略的对象。
PeriodicModeProperties	定期模式备份的配置值。
PhysicalPartitionStorageInfo	物理分区的存储。
PhysicalPartitionStorageInfoCollection	合并操作返回的物理分区及其属性的列表。
PhysicalPartitionThroughputInfoResource	PhysicalPartitionThroughputInfo 对象。
PhysicalPartitionThroughputInfoResult	Azure Cosmos DB PhysicalPartitionThroughputInfoResult 对象。
RedistributeThroughputParameters	Cosmos DB 重新分发吞吐量参数对象。
RedistributeThroughputPropertiesResource	用于重新分发 Azure Cosmos DB 资源的吞吐量的资源。
RegionForOnlineOffline	将 Cosmos DB 区域设置为联机或脱机。
ResourceRestoreParameters	指示有关还原的信息的参数。
RestorableGremlinDatabase	Azure Cosmos DB Gremlin 数据库事件。
RestorableGremlinGraph	Azure Cosmos DB Gremlin 图形事件。
RestorableGremlinResourceData	要还原的特定数据库。
RestorableLocationResourceInfo	区域可还原帐户的属性。
RestorableMongoDBCollection	Azure Cosmos DB MongoDB 收集事件。
RestorableMongoDBDatabase	Azure Cosmos DB MongoDB 数据库事件。
RestorableMongoDBResourceData	要还原的特定数据库。
RestorableSqlContainer	Azure Cosmos DB SQL 容器事件。
RestorableSqlContainerPropertiesResourceContainer	Cosmos DB SQL 容器资源对象。
RestorableSqlDatabase	Azure Cosmos DB SQL 数据库事件。
RestorableSqlDatabasePropertiesResourceDatabase	Cosmos DB SQL 数据库资源对象。
RestorableSqlResourceData	要还原的特定数据库。
RestorableTable	Azure Cosmos DB 表事件。
RestorableTableResourceData	要还原的特定数据库。
RestoreParametersBase	指示有关还原的信息的参数。
RetrieveThroughputParameters	Cosmos DB 检索吞吐量参数对象。
RetrieveThroughputPropertiesResource	用于检索 Cosmos DB 资源的吞吐量信息的资源。
SpatialSpec	SpatialSpec。
SqlDedicatedGatewayRegionalService	区域服务位置的资源。
SqlDedicatedGatewayServiceProperties	SqlDedicatedGatewayServiceResource 的属性。
ThroughputPolicyResourceInfo	Cosmos DB 资源吞吐量策略。
ThroughputSettingsResourceInfo	Cosmos DB 资源吞吐量对象。需要吞吐量，或者需要 autoscaleSettings，但不能同时满足这两项要求。
ThroughputSettingsUpdateData	用于更新 Cosmos DB 资源吞吐量的参数。

结构

AnalyticalStorageSchemaType	描述分析存储的架构类型。
BackupPolicyMigrationStatus	描述备份策略类型之间的迁移状态。
BackupPolicyType	描述备份模式。
CassandraAuthenticationMethod	Cassandra 应使用哪种身份验证方法对客户端进行身份验证。 “无”会关闭身份验证，因此除非在紧急情况下，否则不应使用。 “Cassandra”是基于密码的默认身份验证。默认值为“Cassandra”。
CassandraClusterBackupState	备份的当前状态。
CassandraClusterType	群集的类型。如果设置为“生产”，则群集上可能不允许执行某些操作。
CassandraConnectionState	发生的连接错误的类型。
CassandraNodeState	Cassandra 环中节点的状态。
CassandraProvisioningState	调用操作时资源的状态。
CompositePathSortOrder	复合路径的排序顺序。
ConflictResolutionMode	指示冲突解决模式。
ConnectorOffer	Cassandra 连接器为 Cosmos DB C* 数据库帐户提供类型。
ContinuousTier	用于指示连续备份层类型的枚举。
CosmosDBAccountCreateMode	用于指示帐户创建模式的枚举。
CosmosDBAccountKeyKind	要重新生成的访问密钥。
CosmosDBAccountKind	指示数据库帐户的类型。这只能在创建数据库帐户时进行设置。
CosmosDBAccountOfferType	Cosmos DB 数据库帐户的套餐类型。
CosmosDBAccountRestoreMode	描述还原模式。
CosmosDBApiType	用于指示可还原数据库帐户的 API 类型的枚举。
CosmosDBBackupStorageRedundancy	用于指示备份存储冗余类型的枚举。
CosmosDBDataType	对其应用索引行为的数据类型。
CosmosDBIndexingMode	指示索引模式。
CosmosDBIndexKind	指示索引的类型。
CosmosDBKind	连接字符串键的类型。
CosmosDBMetricPrimaryAggregationType	指标的主要聚合类型。
CosmosDBMetricUnitType	指标的单位。
CosmosDBMinimalTlsVersion	指示允许的最低 Tls 版本。默认值为 Tls 1.0，Cassandra 和 Mongo API 除外，后者仅适用于 Tls 1.2。
CosmosDBNameUnavailableReason	给定名称不可用的原因。
CosmosDBOperationType	用于指示事件的操作类型的枚举。
CosmosDBPartitionKind	指示用于分区的算法类型。对于 MultiHash，容器创建支持多个分区键 (最多三个) 。
CosmosDBProvisioningState	资源的预配状态。
CosmosDBPublicNetworkAccess	是否允许来自公用网络的请求。
CosmosDBServerVersion	描述 MongoDB 帐户的 ServerVersion。
CosmosDBServiceSize	服务的实例类型。
CosmosDBServiceStatus	描述服务的状态。
CosmosDBServiceType	服务的 ServiceType。
CosmosDBSpatialType	指示索引的空间类型。
CosmosDBSqlTriggerOperation	与触发器关联的操作。
CosmosDBSqlTriggerType	触发器的类型。
CosmosDBStatus	用于指示区域的当前生成状态的枚举。
CosmosDBType	连接字符串的类型。
CustomerManagedKeyStatus	指示帐户上客户管理的密钥功能的状态。如果出现错误，属性将提供故障排除指南。
DefaultPriorityLevel	用于指示请求的默认 priorityLevel 的枚举。
MongoClusterStatus	调用操作时资源的状态。
NodeKind	mongo 群集中的节点类型。
ThroughputPolicyType	要应用于吞吐量重新分发的 ThroughputPolicy。

枚举

CosmosDBSqlRoleDefinitionType	指示角色定义是内置还是用户创建。
DefaultConsistencyLevel	Cosmos DB 帐户的默认一致性级别和配置设置。
EnableFullTextQuery	描述要记录查询的详细信息级别。
MongoDBRoleDefinitionType	指示角色定义是内置还是用户创建。
NetworkAclBypass	指示允许哪些服务绕过防火墙检查。

通过

Azure.ResourceManager.CosmosDB.Models 命名空间

类

结构

枚举

其他资源