你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
CosmosDBAccountResource 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
表示 CosmosDBAccount 的类，以及可对其进行执行的实例操作。 如果有 ，ResourceIdentifier则可以使用 GetCosmosDBAccountResource 方法从 实例ArmClient构造 CosmosDBAccountResource 。 否则，可以使用 GetCosmosDBAccount 方法从其父资源 ResourceGroupResource 获取一个。
public class CosmosDBAccountResource : Azure.ResourceManager.ArmResourcetype CosmosDBAccountResource = class
inherit ArmResourcePublic Class CosmosDBAccountResource
Inherits ArmResource- 继承
构造函数
| CosmosDBAccountResource() |
初始化 类的新实例 CosmosDBAccountResource 进行模拟。 |
字段
| ResourceType |
获取操作的资源类型。 |
属性
| Client |
获取 ArmClient 创建自的此资源客户端。 (继承自 ArmResource) |
| Data |
获取表示此功能的数据。 |
| Diagnostics |
获取此资源客户端的诊断选项。 (继承自 ArmResource) |
| Endpoint |
获取此资源客户端的基 URI。 (继承自 ArmResource) |
| HasData |
获取当前实例是否具有数据。 |
| Id |
获取资源标识符。 (继承自 ArmResource) |
| Pipeline |
获取此资源客户端的管道。 (继承自 ArmResource) |
方法
| AddTag(String, String, CancellationToken) |
将标记添加到当前资源。
|
| AddTagAsync(String, String, CancellationToken) |
将标记添加到当前资源。
|
| CanUseTagResource(CancellationToken) |
检查 TagResource API 是否部署在当前环境中。 (继承自 ArmResource) |
| CanUseTagResourceAsync(CancellationToken) |
检查 TagResource API 是否部署在当前环境中。 (继承自 ArmResource) |
| CreateResourceIdentifier(String, String, String) |
生成实例的资源标识符 CosmosDBAccountResource 。 |
| Delete(WaitUntil, CancellationToken) |
删除现有的 Azure Cosmos DB 数据库帐户。
|
| DeleteAsync(WaitUntil, CancellationToken) |
删除现有的 Azure Cosmos DB 数据库帐户。
|
| FailoverPriorityChange(WaitUntil, CosmosDBFailoverPolicies, CancellationToken) |
更改 Azure Cosmos DB 数据库帐户的故障转移优先级。 故障转移优先级为 0 表示写入区域。 故障转移优先级的最大值 = (总区域数 - 1) 。 对于数据库帐户所在的每个区域，故障转移优先级值必须是唯一的。
|
| FailoverPriorityChangeAsync(WaitUntil, CosmosDBFailoverPolicies, CancellationToken) |
更改 Azure Cosmos DB 数据库帐户的故障转移优先级。 故障转移优先级为 0 表示写入区域。 故障转移优先级的最大值 = (总区域数 - 1) 。 对于数据库帐户所在的每个区域，故障转移优先级值必须是唯一的。
|
| Get(CancellationToken) |
检索现有 Azure Cosmos DB 数据库帐户的属性。
|
| GetAsync(CancellationToken) |
检索现有 Azure Cosmos DB 数据库帐户的属性。
|
| GetAvailableLocations(CancellationToken) |
列出所有可用的地理位置。 (继承自 ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
列出所有可用的地理位置。 (继承自 ArmResource) |
| GetCassandraKeyspace(String, CancellationToken) |
获取现有 Azure Cosmos DB 数据库帐户下提供的名称的 Cassandra 密钥空间。
|
| GetCassandraKeyspaceAsync(String, CancellationToken) |
获取现有 Azure Cosmos DB 数据库帐户下提供的名称的 Cassandra 密钥空间。
|
| GetCassandraKeyspaces() |
获取 CosmosDBAccount 中 CassandraKeyspaceResources 的集合。 |
| GetConnectionStrings(CancellationToken) |
列出指定 Azure Cosmos DB 数据库帐户的连接字符串。
|
| GetConnectionStringsAsync(CancellationToken) |
列出指定 Azure Cosmos DB 数据库帐户的连接字符串。
|
| GetCosmosDBPrivateEndpointConnection(String, CancellationToken) |
获取专用终结点连接。
|
| GetCosmosDBPrivateEndpointConnectionAsync(String, CancellationToken) |
获取专用终结点连接。
|
| GetCosmosDBPrivateEndpointConnections() |
获取 CosmosDBAccount 中 CosmosDBPrivateEndpointConnectionResources 的集合。 |
| GetCosmosDBPrivateLinkResource(String, CancellationToken) |
获取需要为 Cosmos DB 帐户创建的专用链接资源。
|
| GetCosmosDBPrivateLinkResourceAsync(String, CancellationToken) |
获取需要为 Cosmos DB 帐户创建的专用链接资源。
|
| GetCosmosDBPrivateLinkResources() |
获取 CosmosDBAccount 中 CosmosDBPrivateLinkResources 的集合。 |
| GetCosmosDBService(String, CancellationToken) |
获取服务的状态。
|
| GetCosmosDBServiceAsync(String, CancellationToken) |
获取服务的状态。
|
| GetCosmosDBServices() |
获取 CosmosDBAccount 中 CosmosDBServiceResources 的集合。 |
| GetCosmosDBSqlDatabase(String, CancellationToken) |
获取现有 Azure Cosmos DB 数据库帐户下提供的名称的 SQL 数据库。
|
| GetCosmosDBSqlDatabaseAsync(String, CancellationToken) |
获取现有 Azure Cosmos DB 数据库帐户下提供的名称的 SQL 数据库。
|
| GetCosmosDBSqlDatabases() |
获取 CosmosDBAccount 中 CosmosDBSqlDatabaseResources 的集合。 |
| GetCosmosDBSqlRoleAssignment(String, CancellationToken) |
检索具有给定 ID 的现有 Azure Cosmos DB SQL 角色分配的属性。
|
| GetCosmosDBSqlRoleAssignmentAsync(String, CancellationToken) |
检索具有给定 ID 的现有 Azure Cosmos DB SQL 角色分配的属性。
|
| GetCosmosDBSqlRoleAssignments() |
获取 CosmosDBAccount 中 CosmosDBSqlRoleAssignmentResources 的集合。 |
| GetCosmosDBSqlRoleDefinition(String, CancellationToken) |
检索具有给定 ID 的现有 Azure Cosmos DB SQL 角色定义的属性。
|
| GetCosmosDBSqlRoleDefinitionAsync(String, CancellationToken) |
检索具有给定 ID 的现有 Azure Cosmos DB SQL 角色定义的属性。
|
| GetCosmosDBSqlRoleDefinitions() |
获取 CosmosDBAccount 中 CosmosDBSqlRoleDefinitionResources 的集合。 |
| GetCosmosDBTable(String, CancellationToken) |
获取具有提供名称的现有 Azure Cosmos DB 数据库帐户下的表。
|
| GetCosmosDBTableAsync(String, CancellationToken) |
获取具有提供名称的现有 Azure Cosmos DB 数据库帐户下的表。
|
| GetCosmosDBTables() |
获取 CosmosDBAccount 中 CosmosDBTableResources 的集合。 |
| GetDataTransferJobGetResult(String, CancellationToken) |
获取数据传输作业。
|
| GetDataTransferJobGetResultAsync(String, CancellationToken) |
获取数据传输作业。
|
| GetDataTransferJobGetResults() |
获取 CosmosDBAccount 中 DataTransferJobGetResultResources 的集合。 |
| GetGraphResourceGetResult(String, CancellationToken) |
获取现有 Azure Cosmos DB 数据库帐户下提供的名称的 Graph 资源。
|
| GetGraphResourceGetResultAsync(String, CancellationToken) |
获取现有 Azure Cosmos DB 数据库帐户下提供的名称的 Graph 资源。
|
| GetGraphResourceGetResults() |
获取 CosmosDBAccount 中 GraphResourceGetResultResources 的集合。 |
| GetGremlinDatabase(String, CancellationToken) |
获取现有 Azure Cosmos DB 数据库帐户下提供的名称的 Gremlin 数据库。
|
| GetGremlinDatabaseAsync(String, CancellationToken) |
获取现有 Azure Cosmos DB 数据库帐户下提供的名称的 Gremlin 数据库。
|
| GetGremlinDatabases() |
获取 CosmosDBAccount 中 GremlinDatabaseResources 的集合。 |
| GetKeys(CancellationToken) |
列出指定 Azure Cosmos DB 数据库帐户的访问密钥。
|
| GetKeysAsync(CancellationToken) |
列出指定 Azure Cosmos DB 数据库帐户的访问密钥。
|
| GetManagementLock(String, CancellationToken) |
按范围获取管理锁。
|
| GetManagementLockAsync(String, CancellationToken) |
按范围获取管理锁。
|
| GetManagementLocks() |
获取 ArmResource 中的 ManagementLockResources 集合。 (继承自 ArmResource) |
| GetMetricDefinitions(CancellationToken) |
检索给定数据库帐户的指标定义。
|
| GetMetricDefinitionsAsync(CancellationToken) |
检索给定数据库帐户的指标定义。
|
| GetMetricDefinitionsCollections(String, String, CancellationToken) |
检索给定集合的指标定义。
|
| GetMetricDefinitionsCollectionsAsync(String, String, CancellationToken) |
检索给定集合的指标定义。
|
| GetMetricDefinitionsDatabases(String, CancellationToken) |
检索给定数据库的指标定义。
|
| GetMetricDefinitionsDatabasesAsync(String, CancellationToken) |
检索给定数据库的指标定义。
|
| GetMetrics(String, CancellationToken) |
检索给定数据库帐户的给定筛选器确定的指标。
|
| GetMetricsAsync(String, CancellationToken) |
检索给定数据库帐户的给定筛选器确定的指标。
|
| GetMetricsCollectionPartitionRegions(String, String, String, String, CancellationToken) |
检索由给定筛选器为给定集合和区域确定的指标，并按分区拆分。
|
| GetMetricsCollectionPartitionRegionsAsync(String, String, String, String, CancellationToken) |
检索由给定筛选器为给定集合和区域确定的指标，并按分区拆分。
|
| GetMetricsCollectionPartitions(String, String, String, CancellationToken) |
检索给定筛选器为给定集合确定的指标，按分区拆分。
|
| GetMetricsCollectionPartitionsAsync(String, String, String, CancellationToken) |
检索给定筛选器为给定集合确定的指标，按分区拆分。
|
| GetMetricsCollectionRegions(String, String, String, String, CancellationToken) |
检索给定筛选器为给定数据库帐户、集合和区域确定的指标。
|
| GetMetricsCollectionRegionsAsync(String, String, String, String, CancellationToken) |
检索给定筛选器为给定数据库帐户、集合和区域确定的指标。
|
| GetMetricsCollections(String, String, String, CancellationToken) |
检索由给定筛选器为给定数据库帐户和集合确定的指标。
|
| GetMetricsCollectionsAsync(String, String, String, CancellationToken) |
检索由给定筛选器为给定数据库帐户和集合确定的指标。
|
| GetMetricsDatabaseAccountRegions(String, String, CancellationToken) |
检索给定筛选器为给定数据库帐户和区域确定的指标。
|
| GetMetricsDatabaseAccountRegionsAsync(String, String, CancellationToken) |
检索给定筛选器为给定数据库帐户和区域确定的指标。
|
| GetMetricsDatabases(String, String, CancellationToken) |
检索给定筛选器为给定数据库帐户和数据库确定的指标。
|
| GetMetricsDatabasesAsync(String, String, CancellationToken) |
检索给定筛选器为给定数据库帐户和数据库确定的指标。
|
| GetMetricsPartitionKeyRangeIdRegions(String, String, String, String, String, CancellationToken) |
检索由给定筛选器为给定分区键范围 ID 和区域确定的指标。
|
| GetMetricsPartitionKeyRangeIdRegionsAsync(String, String, String, String, String, CancellationToken) |
检索由给定筛选器为给定分区键范围 ID 和区域确定的指标。
|
| GetMetricsPartitionKeyRangeIds(String, String, String, String, CancellationToken) |
检索给定筛选器为给定分区键范围 ID 确定的指标。
|
| GetMetricsPartitionKeyRangeIdsAsync(String, String, String, String, CancellationToken) |
检索给定筛选器为给定分区键范围 ID 确定的指标。
|
| GetMetricsPercentiles(String, CancellationToken) |
检索给定数据库帐户的给定筛选器确定的指标。 此 URL 仅适用于 PBS 和复制延迟数据
|
| GetMetricsPercentilesAsync(String, CancellationToken) |
检索给定数据库帐户的给定筛选器确定的指标。 此 URL 仅适用于 PBS 和复制延迟数据
|
| GetMetricsPercentileSourceTargets(String, String, String, CancellationToken) |
检索给定筛选器为给定帐户、源和目标区域确定的指标。 此 URL 仅适用于 PBS 和复制延迟数据
|
| GetMetricsPercentileSourceTargetsAsync(String, String, String, CancellationToken) |
检索给定筛选器为给定帐户、源和目标区域确定的指标。 此 URL 仅适用于 PBS 和复制延迟数据
|
| GetMetricsPercentileTargets(String, String, CancellationToken) |
检索给定筛选器为给定帐户目标区域确定的指标。 此 URL 仅适用于 PBS 和复制延迟数据
|
| GetMetricsPercentileTargetsAsync(String, String, CancellationToken) |
检索给定筛选器为给定帐户目标区域确定的指标。 此 URL 仅适用于 PBS 和复制延迟数据
|
| GetMongoDBDatabase(String, CancellationToken) |
获取现有 Azure Cosmos DB 数据库帐户下提供的名称的 MongoDB 数据库。
|
| GetMongoDBDatabaseAsync(String, CancellationToken) |
获取现有 Azure Cosmos DB 数据库帐户下提供的名称的 MongoDB 数据库。
|
| GetMongoDBDatabases() |
获取 CosmosDBAccount 中 MongoDBDatabaseResources 的集合。 |
| GetMongoDBRoleDefinition(String, CancellationToken) |
检索具有给定 ID 的现有 Azure Cosmos DB Mongo 角色定义的属性。
|
| GetMongoDBRoleDefinitionAsync(String, CancellationToken) |
检索具有给定 ID 的现有 Azure Cosmos DB Mongo 角色定义的属性。
|
| GetMongoDBRoleDefinitions() |
获取 CosmosDBAccount 中 MongoDBRoleDefinitionResources 的集合。 |
| GetMongoDBUserDefinition(String, CancellationToken) |
检索具有给定 ID 的现有 Azure Cosmos DB Mongo 用户定义的属性。
|
| GetMongoDBUserDefinitionAsync(String, CancellationToken) |
检索具有给定 ID 的现有 Azure Cosmos DB Mongo 用户定义的属性。
|
| GetMongoDBUserDefinitions() |
获取 CosmosDBAccount 中 MongoDBUserDefinitionResources 的集合。 |
| GetPolicyAssignment(String, CancellationToken) |
此操作检索单个策略分配，给定其名称和创建范围。
|
| GetPolicyAssignmentAsync(String, CancellationToken) |
此操作检索单个策略分配，给定其名称和创建范围。
|
| GetPolicyAssignments() |
获取 ArmResource 中 PolicyAssignmentResources 的集合。 (继承自 ArmResource) |
| GetReadOnlyKeys(CancellationToken) |
列出指定 Azure Cosmos DB 数据库帐户的只读访问密钥。
|
| GetReadOnlyKeysAsync(CancellationToken) |
列出指定 Azure Cosmos DB 数据库帐户的只读访问密钥。
|
| GetTagResource() |
获取一个 对象，该对象表示 TagResource 以及可在 ArmResource 中对其进行执行的实例操作。 (继承自 ArmResource) |
| GetUsages(String, CancellationToken) |
检索给定数据库帐户 (最新数据) 使用情况。
|
| GetUsagesAsync(String, CancellationToken) |
检索给定数据库帐户 (最新数据) 使用情况。
|
| GetUsagesCollectionPartitions(String, String, String, CancellationToken) |
检索给定集合的最新存储数据) (使用情况，按分区拆分。
|
| GetUsagesCollectionPartitionsAsync(String, String, String, CancellationToken) |
检索给定集合的最新存储数据) (使用情况，按分区拆分。
|
| GetUsagesCollections(String, String, String, CancellationToken) |
检索给定集合的最新存储数据) (用法。
|
| GetUsagesCollectionsAsync(String, String, String, CancellationToken) |
检索给定集合的最新存储数据) (用法。
|
| GetUsagesDatabases(String, String, CancellationToken) |
检索给定数据库的最新数据) (用法。
|
| GetUsagesDatabasesAsync(String, String, CancellationToken) |
检索给定数据库的最新数据) (用法。
|
| OfflineRegion(WaitUntil, RegionForOnlineOffline, CancellationToken) |
脱机指定 Azure Cosmos DB 数据库帐户的指定区域。
|
| OfflineRegionAsync(WaitUntil, RegionForOnlineOffline, CancellationToken) |
脱机指定 Azure Cosmos DB 数据库帐户的指定区域。
|
| OnlineRegion(WaitUntil, RegionForOnlineOffline, CancellationToken) |
联机指定 Azure Cosmos DB 数据库帐户的指定区域。
|
| OnlineRegionAsync(WaitUntil, RegionForOnlineOffline, CancellationToken) |
联机指定 Azure Cosmos DB 数据库帐户的指定区域。
|
| RegenerateKey(WaitUntil, CosmosDBAccountRegenerateKeyContent, CancellationToken) |
为指定的 Azure Cosmos DB 数据库帐户重新生成访问密钥。
|
| RegenerateKeyAsync(WaitUntil, CosmosDBAccountRegenerateKeyContent, CancellationToken) |
为指定的 Azure Cosmos DB 数据库帐户重新生成访问密钥。
|
| RemoveTag(String, CancellationToken) |
按键从资源中删除标记。
|
| RemoveTagAsync(String, CancellationToken) |
按键从资源中删除标记。
|
| SetTags(IDictionary<String,String>, CancellationToken) |
将资源上的标记替换为给定集。
|
| SetTagsAsync(IDictionary<String,String>, CancellationToken) |
将资源上的标记替换为给定集。
|
| TryGetApiVersion(ResourceType, String) |
获取 API 版本替代（如果已为当前客户端选项设置）。 (继承自 ArmResource) |
| Update(WaitUntil, CosmosDBAccountPatch, CancellationToken) |
汇报现有 Azure Cosmos DB 数据库帐户的属性。
|
| UpdateAsync(WaitUntil, CosmosDBAccountPatch, CancellationToken) |
汇报现有 Azure Cosmos DB 数据库帐户的属性。
|
扩展方法
| GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
按名称 (GUID) 获取角色定义。
|
| GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
按名称 (GUID) 获取角色定义。
|
| GetAuthorizationRoleDefinitions(ArmResource) |
获取 ArmResource 中 AuthorizationRoleDefinitionResources 的集合。 |
| GetDenyAssignment(ArmResource, String, CancellationToken) |
获取指定的拒绝分配。
|
| GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
获取指定的拒绝分配。
|
| GetDenyAssignments(ArmResource) |
获取 ArmResource 中 DenyAssignmentResources 的集合。 |
| GetRoleAssignment(ArmResource, String, String, CancellationToken) |
按范围和名称获取角色分配。
|
| GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
按范围和名称获取角色分配。
|
| GetRoleAssignments(ArmResource) |
获取 ArmResource 中 RoleAssignmentResources 的集合。 |
| GetRoleAssignmentSchedule(ArmResource, String, CancellationToken) |
获取资源范围的指定角色分配计划
|
| GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
获取资源范围的指定角色分配计划
|
| GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
获取指定的角色分配计划实例。
|
| GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
获取指定的角色分配计划实例。
|
| GetRoleAssignmentScheduleInstances(ArmResource) |
获取 ArmResource 中 RoleAssignmentScheduleInstanceResources 的集合。 |
| GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken) |
获取指定的角色分配计划请求。
|
| GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
获取指定的角色分配计划请求。
|
| GetRoleAssignmentScheduleRequests(ArmResource) |
获取 ArmResource 中 RoleAssignmentScheduleRequestResources 的集合。 |
| GetRoleAssignmentSchedules(ArmResource) |
获取 ArmResource 中 RoleAssignmentScheduleResources 的集合。 |
| GetRoleEligibilitySchedule(ArmResource, String, CancellationToken) |
获取资源范围的指定角色资格计划
|
| GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
获取资源范围的指定角色资格计划
|
| GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
获取指定的角色资格计划实例。
|
| GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
获取指定的角色资格计划实例。
|
| GetRoleEligibilityScheduleInstances(ArmResource) |
获取 ArmResource 中 RoleEligibilityScheduleInstanceResources 的集合。 |
| GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken) |
获取指定的角色资格计划请求。
|
| GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
获取指定的角色资格计划请求。
|
| GetRoleEligibilityScheduleRequests(ArmResource) |
获取 ArmResource 中 RoleEligibilityScheduleRequestResources 的集合。 |
| GetRoleEligibilitySchedules(ArmResource) |
获取 ArmResource 中 RoleEligibilityScheduleResources 的集合。 |
| GetRoleManagementPolicies(ArmResource) |
获取 ArmResource 中 RoleManagementPolicyResources 的集合。 |
| GetRoleManagementPolicy(ArmResource, String, CancellationToken) |
获取资源范围的指定角色管理策略
|
| GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
获取资源范围的指定角色管理策略分配
|
| GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
获取资源范围的指定角色管理策略分配
|
| GetRoleManagementPolicyAssignments(ArmResource) |
获取 ArmResource 中 RoleManagementPolicyAssignmentResources 的集合。 |
| GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken) |
获取资源范围的指定角色管理策略
|
| GetSystemAssignedIdentity(ArmResource) |
获取一个 对象，该对象表示 SystemAssignedIdentityResource 以及可在 ArmResource 中对它执行的实例操作。 |
| GetLinkerResource(ArmResource, String, CancellationToken) |
返回给定名称的链接器资源。
|
| GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
返回给定名称的链接器资源。
|
| GetLinkerResources(ArmResource) |
获取 ArmResource 中 LinkerResources 的集合。 |