DatabaseAccounts interface
表示 DatabaseAccounts 的接口。
方法
方法详细信息
beginCreateOrUpdate(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
创建或更新 Azure Cosmos DB 数据库帐户。 在帐户上执行更新时，首选“更新”方法。
function beginCreateOrUpdate(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
要为当前数据库帐户提供的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginCreateOrUpdateAndWait(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
创建或更新 Azure Cosmos DB 数据库帐户。 在帐户上执行更新时，首选“更新”方法。
function beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<DatabaseAccountGetResults>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
要为当前数据库帐户提供的参数。
选项参数。
返回
Promise<DatabaseAccountGetResults>
beginDelete(string, string, DatabaseAccountsDeleteOptionalParams)
删除现有的 Azure Cosmos DB 数据库帐户。
function beginDelete(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>
beginDeleteAndWait(string, string, DatabaseAccountsDeleteOptionalParams)
删除现有的 Azure Cosmos DB 数据库帐户。
function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<DatabaseAccountsDeleteHeaders>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
Promise<DatabaseAccountsDeleteHeaders>
beginFailoverPriorityChange(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
更改 Azure Cosmos DB 数据库帐户的故障转移优先级。 故障转移优先级为 0 表示写入区域。 故障转移优先级的最大值 = （区域总数 - 1）。 故障转移优先级值对于数据库帐户所在的每个区域必须是唯一的。
function beginFailoverPriorityChange(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- failoverParameters
- FailoverPolicies
数据库帐户的新故障转移策略。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>
beginFailoverPriorityChangeAndWait(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
更改 Azure Cosmos DB 数据库帐户的故障转移优先级。 故障转移优先级为 0 表示写入区域。 故障转移优先级的最大值 = （区域总数 - 1）。 故障转移优先级值对于数据库帐户所在的每个区域必须是唯一的。
function beginFailoverPriorityChangeAndWait(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<DatabaseAccountsFailoverPriorityChangeHeaders>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- failoverParameters
- FailoverPolicies
数据库帐户的新故障转移策略。
选项参数。
返回
beginOfflineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
为指定的 Azure Cosmos DB 数据库帐户脱机指定的区域。
function beginOfflineRegion(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- regionParameterForOffline
- RegionForOnlineOffline
将 Cosmos DB 区域脱机用于数据库帐户。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOfflineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
为指定的 Azure Cosmos DB 数据库帐户脱机指定的区域。
function beginOfflineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- regionParameterForOffline
- RegionForOnlineOffline
将 Cosmos DB 区域脱机用于数据库帐户。
选项参数。
返回
Promise<void>
beginOnlineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
联机指定 Azure Cosmos DB 数据库帐户的指定区域。
function beginOnlineRegion(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- regionParameterForOnline
- RegionForOnlineOffline
要联机用于数据库帐户的 Cosmos DB 区域。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOnlineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
联机指定 Azure Cosmos DB 数据库帐户的指定区域。
function beginOnlineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- regionParameterForOnline
- RegionForOnlineOffline
要联机用于数据库帐户的 Cosmos DB 区域。
选项参数。
返回
Promise<void>
beginRegenerateKey(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
为指定的 Azure Cosmos DB 数据库帐户重新生成访问密钥。
function beginRegenerateKey(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
要重新生成的密钥的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRegenerateKeyAndWait(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
为指定的 Azure Cosmos DB 数据库帐户重新生成访问密钥。
function beginRegenerateKeyAndWait(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
要重新生成的密钥的名称。
选项参数。
返回
Promise<void>
beginUpdate(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
更新现有 Azure Cosmos DB 数据库帐户的属性。
function beginUpdate(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- updateParameters
- DatabaseAccountUpdateParameters
要为当前数据库帐户提供的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginUpdateAndWait(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
更新现有 Azure Cosmos DB 数据库帐户的属性。
function beginUpdateAndWait(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<DatabaseAccountGetResults>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- updateParameters
- DatabaseAccountUpdateParameters
要为当前数据库帐户提供的参数。
选项参数。
返回
Promise<DatabaseAccountGetResults>
checkNameExists(string, DatabaseAccountsCheckNameExistsOptionalParams)
检查 Azure Cosmos DB 帐户名称是否已存在。 有效的帐户名称只能包含小写字母、数字和“-”字符，并且必须介于 3 到 50 个字符之间。
function checkNameExists(accountName: string, options?: DatabaseAccountsCheckNameExistsOptionalParams): Promise<DatabaseAccountsCheckNameExistsResponse>参数
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
get(string, string, DatabaseAccountsGetOptionalParams)
检索现有 Azure Cosmos DB 数据库帐户的属性。
function get(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetOptionalParams): Promise<DatabaseAccountGetResults>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
Promise<DatabaseAccountGetResults>
getReadOnlyKeys(string, string, DatabaseAccountsGetReadOnlyKeysOptionalParams)
列出指定 Azure Cosmos DB 数据库帐户的只读访问密钥。
function getReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
list(DatabaseAccountsListOptionalParams)
列出订阅下提供的所有 Azure Cosmos DB 数据库帐户。
function list(options?: DatabaseAccountsListOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>参数
选项参数。
返回
listByResourceGroup(string, DatabaseAccountsListByResourceGroupOptionalParams)
列出给定资源组下可用的所有 Azure Cosmos DB 数据库帐户。
function listByResourceGroup(resourceGroupName: string, options?: DatabaseAccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
选项参数。
返回
listConnectionStrings(string, string, DatabaseAccountsListConnectionStringsOptionalParams)
列出指定 Azure Cosmos DB 数据库帐户的连接字符串。
function listConnectionStrings(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListConnectionStringsOptionalParams): Promise<DatabaseAccountListConnectionStringsResult>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
listKeys(string, string, DatabaseAccountsListKeysOptionalParams)
列出指定 Azure Cosmos DB 数据库帐户的访问密钥。
function listKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListKeysOptionalParams): Promise<DatabaseAccountListKeysResult>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
Promise<DatabaseAccountListKeysResult>
listMetricDefinitions(string, string, DatabaseAccountsListMetricDefinitionsOptionalParams)
检索给定数据库帐户的指标定义。
function listMetricDefinitions(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
listMetrics(string, string, string, DatabaseAccountsListMetricsOptionalParams)
检索由给定数据库帐户的给定筛选器确定的指标。
function listMetrics(resourceGroupName: string, accountName: string, filter: string, options?: DatabaseAccountsListMetricsOptionalParams): PagedAsyncIterableIterator<Metric, Metric[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- filter
-
string
描述要返回的指标子集的 OData 筛选器表达式。 可筛选的参数是 name.value（指标的名称、可以具有多个名称）、startTime、endTime 和 timeGrain。 支持的运算符为 eq。
选项参数。
返回
listReadOnlyKeys(string, string, DatabaseAccountsListReadOnlyKeysOptionalParams)
列出指定 Azure Cosmos DB 数据库帐户的只读访问密钥。
function listReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
listUsages(string, string, DatabaseAccountsListUsagesOptionalParams)
检索给定数据库帐户的使用情况（最新数据）。
function listUsages(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListUsagesOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
