DatabaseAccounts interface
Interface que representa um DatabaseAccounts.
Métodos
| begin |
Cria ou atualiza uma conta de banco de dados do Azure Cosmos DB. O método "Update" é preferencial ao executar atualizações em uma conta. |
| begin |
Cria ou atualiza uma conta de banco de dados do Azure Cosmos DB. O método "Update" é preferencial ao executar atualizações em uma conta. |
| begin |
Exclui uma conta de banco de dados existente do Azure Cosmos DB. |
| begin |
Exclui uma conta de banco de dados existente do Azure Cosmos DB. |
| begin |
Altera a prioridade de failover para a conta de banco de dados do Azure Cosmos DB. Uma prioridade de failover de 0 indica uma região de gravação. O valor máximo para uma prioridade de failover = (número total de regiões – 1). Os valores de prioridade de failover devem ser exclusivos para cada uma das regiões nas quais a conta de banco de dados existe. |
| begin |
Altera a prioridade de failover para a conta de banco de dados do Azure Cosmos DB. Uma prioridade de failover de 0 indica uma região de gravação. O valor máximo para uma prioridade de failover = (número total de regiões – 1). Os valores de prioridade de failover devem ser exclusivos para cada uma das regiões nas quais a conta de banco de dados existe. |
| begin |
Offline a região especificada para a conta de banco de dados do Azure Cosmos DB especificada. |
| begin |
Offline a região especificada para a conta de banco de dados do Azure Cosmos DB especificada. |
| begin |
Online, a região especificada para a conta de banco de dados do Azure Cosmos DB especificada. |
| begin |
Online, a região especificada para a conta de banco de dados do Azure Cosmos DB especificada. |
| begin |
Regenera uma chave de acesso para a conta de banco de dados do Azure Cosmos DB especificada. |
| begin |
Regenera uma chave de acesso para a conta de banco de dados do Azure Cosmos DB especificada. |
| begin |
Atualiza as propriedades de uma conta de banco de dados existente do Azure Cosmos DB. |
| begin |
Atualiza as propriedades de uma conta de banco de dados existente do Azure Cosmos DB. |
| check |
Verifica se o nome da conta do Azure Cosmos DB já existe. Um nome de conta válido pode conter apenas letras minúsculas, números e o caractere '-' e deve ter entre 3 e 50 caracteres. |
| get(string, string, Database |
Recupera as propriedades de uma conta de banco de dados existente do Azure Cosmos DB. |
| get |
Lista as chaves de acesso somente leitura para a conta de banco de dados do Azure Cosmos DB especificada. |
| list(Database |
Lista todas as contas de banco de dados do Azure Cosmos DB disponíveis na assinatura. |
| list |
Lista todas as contas de banco de dados do Azure Cosmos DB disponíveis no grupo de recursos especificado. |
| list |
Lista as cadeias de conexão para a conta de banco de dados do Azure Cosmos DB especificada. |
| list |
Lista as chaves de acesso para a conta de banco de dados do Azure Cosmos DB especificada. |
| list |
Recupera definições de métrica para a conta de banco de dados fornecida. |
| list |
Recupera as métricas determinadas pelo filtro determinado para a conta de banco de dados fornecida. |
| list |
Lista as chaves de acesso somente leitura para a conta de banco de dados do Azure Cosmos DB especificada. |
| list |
Recupera os usos (dados mais recentes) para a conta de banco de dados fornecida. |
Detalhes do método
beginCreateOrUpdate(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Cria ou atualiza uma conta de banco de dados do Azure Cosmos DB. O método "Update" é preferencial ao executar atualizações em uma conta.
function beginCreateOrUpdate(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
Os parâmetros a serem fornecidos para a conta de banco de dados atual.
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginCreateOrUpdateAndWait(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Cria ou atualiza uma conta de banco de dados do Azure Cosmos DB. O método "Update" é preferencial ao executar atualizações em uma conta.
function beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<DatabaseAccountGetResults>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
Os parâmetros a serem fornecidos para a conta de banco de dados atual.
Os parâmetros de opções.
Retornos
Promise<DatabaseAccountGetResults>
beginDelete(string, string, DatabaseAccountsDeleteOptionalParams)
Exclui uma conta de banco de dados existente do Azure Cosmos DB.
function beginDelete(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>
beginDeleteAndWait(string, string, DatabaseAccountsDeleteOptionalParams)
Exclui uma conta de banco de dados existente do Azure Cosmos DB.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<DatabaseAccountsDeleteHeaders>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
Os parâmetros de opções.
Retornos
Promise<DatabaseAccountsDeleteHeaders>
beginFailoverPriorityChange(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
Altera a prioridade de failover para a conta de banco de dados do Azure Cosmos DB. Uma prioridade de failover de 0 indica uma região de gravação. O valor máximo para uma prioridade de failover = (número total de regiões – 1). Os valores de prioridade de failover devem ser exclusivos para cada uma das regiões nas quais a conta de banco de dados existe.
function beginFailoverPriorityChange(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- failoverParameters
- FailoverPolicies
As novas políticas de failover para a conta de banco de dados.
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>
beginFailoverPriorityChangeAndWait(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
Altera a prioridade de failover para a conta de banco de dados do Azure Cosmos DB. Uma prioridade de failover de 0 indica uma região de gravação. O valor máximo para uma prioridade de failover = (número total de regiões – 1). Os valores de prioridade de failover devem ser exclusivos para cada uma das regiões nas quais a conta de banco de dados existe.
function beginFailoverPriorityChangeAndWait(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<DatabaseAccountsFailoverPriorityChangeHeaders>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- failoverParameters
- FailoverPolicies
As novas políticas de failover para a conta de banco de dados.
Os parâmetros de opções.
Retornos
beginOfflineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
Offline a região especificada para a conta de banco de dados do Azure Cosmos DB especificada.
function beginOfflineRegion(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- regionParameterForOffline
- RegionForOnlineOffline
Região do Cosmos DB para offline para a conta de banco de dados.
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOfflineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
Offline a região especificada para a conta de banco de dados do Azure Cosmos DB especificada.
function beginOfflineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<void>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- regionParameterForOffline
- RegionForOnlineOffline
Região do Cosmos DB para offline para a conta de banco de dados.
Os parâmetros de opções.
Retornos
Promise<void>
beginOnlineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
Online, a região especificada para a conta de banco de dados do Azure Cosmos DB especificada.
function beginOnlineRegion(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- regionParameterForOnline
- RegionForOnlineOffline
Região do Cosmos DB online para a conta de banco de dados.
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOnlineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
Online, a região especificada para a conta de banco de dados do Azure Cosmos DB especificada.
function beginOnlineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<void>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- regionParameterForOnline
- RegionForOnlineOffline
Região do Cosmos DB online para a conta de banco de dados.
Os parâmetros de opções.
Retornos
Promise<void>
beginRegenerateKey(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
Regenera uma chave de acesso para a conta de banco de dados do Azure Cosmos DB especificada.
function beginRegenerateKey(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
O nome da chave a ser regenerada.
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRegenerateKeyAndWait(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
Regenera uma chave de acesso para a conta de banco de dados do Azure Cosmos DB especificada.
function beginRegenerateKeyAndWait(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<void>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
O nome da chave a ser regenerada.
Os parâmetros de opções.
Retornos
Promise<void>
beginUpdate(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
Atualiza as propriedades de uma conta de banco de dados existente do Azure Cosmos DB.
function beginUpdate(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- updateParameters
- DatabaseAccountUpdateParameters
Os parâmetros a serem fornecidos para a conta de banco de dados atual.
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginUpdateAndWait(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
Atualiza as propriedades de uma conta de banco de dados existente do Azure Cosmos DB.
function beginUpdateAndWait(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<DatabaseAccountGetResults>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- updateParameters
- DatabaseAccountUpdateParameters
Os parâmetros a serem fornecidos para a conta de banco de dados atual.
Os parâmetros de opções.
Retornos
Promise<DatabaseAccountGetResults>
checkNameExists(string, DatabaseAccountsCheckNameExistsOptionalParams)
Verifica se o nome da conta do Azure Cosmos DB já existe. Um nome de conta válido pode conter apenas letras minúsculas, números e o caractere '-' e deve ter entre 3 e 50 caracteres.
function checkNameExists(accountName: string, options?: DatabaseAccountsCheckNameExistsOptionalParams): Promise<DatabaseAccountsCheckNameExistsResponse>
Parâmetros
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
Os parâmetros de opções.
Retornos
get(string, string, DatabaseAccountsGetOptionalParams)
Recupera as propriedades de uma conta de banco de dados existente do Azure Cosmos DB.
function get(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetOptionalParams): Promise<DatabaseAccountGetResults>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
Os parâmetros de opções.
Retornos
Promise<DatabaseAccountGetResults>
getReadOnlyKeys(string, string, DatabaseAccountsGetReadOnlyKeysOptionalParams)
Lista as chaves de acesso somente leitura para a conta de banco de dados do Azure Cosmos DB especificada.
function getReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
Os parâmetros de opções.
Retornos
list(DatabaseAccountsListOptionalParams)
Lista todas as contas de banco de dados do Azure Cosmos DB disponíveis na assinatura.
function list(options?: DatabaseAccountsListOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>
Parâmetros
Os parâmetros de opções.
Retornos
listByResourceGroup(string, DatabaseAccountsListByResourceGroupOptionalParams)
Lista todas as contas de banco de dados do Azure Cosmos DB disponíveis no grupo de recursos especificado.
function listByResourceGroup(resourceGroupName: string, options?: DatabaseAccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
Os parâmetros de opções.
Retornos
listConnectionStrings(string, string, DatabaseAccountsListConnectionStringsOptionalParams)
Lista as cadeias de conexão para a conta de banco de dados do Azure Cosmos DB especificada.
function listConnectionStrings(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListConnectionStringsOptionalParams): Promise<DatabaseAccountListConnectionStringsResult>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
Os parâmetros de opções.
Retornos
listKeys(string, string, DatabaseAccountsListKeysOptionalParams)
Lista as chaves de acesso para a conta de banco de dados do Azure Cosmos DB especificada.
function listKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListKeysOptionalParams): Promise<DatabaseAccountListKeysResult>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
Os parâmetros de opções.
Retornos
Promise<DatabaseAccountListKeysResult>
listMetricDefinitions(string, string, DatabaseAccountsListMetricDefinitionsOptionalParams)
Recupera definições de métrica para a conta de banco de dados fornecida.
function listMetricDefinitions(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
Os parâmetros de opções.
Retornos
listMetrics(string, string, string, DatabaseAccountsListMetricsOptionalParams)
Recupera as métricas determinadas pelo filtro determinado para a conta de banco de dados fornecida.
function listMetrics(resourceGroupName: string, accountName: string, filter: string, options?: DatabaseAccountsListMetricsOptionalParams): PagedAsyncIterableIterator<Metric, Metric[], PageSettings>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
- filter
-
string
Uma expressão de filtro OData que descreve um subconjunto de métricas a serem retornadas. Os parâmetros que podem ser filtrados são name.value (nome da métrica, pode ter um ou de vários nomes), startTime, endTime e timeGrain. O operador com suporte é eq.
Os parâmetros de opções.
Retornos
listReadOnlyKeys(string, string, DatabaseAccountsListReadOnlyKeysOptionalParams)
Lista as chaves de acesso somente leitura para a conta de banco de dados do Azure Cosmos DB especificada.
function listReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
Os parâmetros de opções.
Retornos
listUsages(string, string, DatabaseAccountsListUsagesOptionalParams)
Recupera os usos (dados mais recentes) para a conta de banco de dados fornecida.
function listUsages(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListUsagesOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], PageSettings>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
Nome da conta de banco de dados do Cosmos DB.
Os parâmetros de opções.