DatabaseAccounts interface
Interfejs reprezentujący konto bazy danych.
Metody
| begin |
Tworzy lub aktualizuje konto bazy danych usługi Azure Cosmos DB. Metoda "Update" jest preferowana podczas przeprowadzania aktualizacji na koncie. |
| begin |
Tworzy lub aktualizuje konto bazy danych usługi Azure Cosmos DB. Metoda "Update" jest preferowana podczas przeprowadzania aktualizacji na koncie. |
| begin |
Usuwa istniejące konto bazy danych usługi Azure Cosmos DB. |
| begin |
Usuwa istniejące konto bazy danych usługi Azure Cosmos DB. |
| begin |
Zmienia priorytet trybu failover dla konta bazy danych usługi Azure Cosmos DB. Priorytet pracy w trybie failover 0 wskazuje region zapisu. Maksymalna wartość priorytetu trybu failover = (całkowita liczba regionów — 1). Wartości priorytetów trybu failover muszą być unikatowe dla każdego z regionów, w których istnieje konto bazy danych. |
| begin |
Zmienia priorytet trybu failover dla konta bazy danych usługi Azure Cosmos DB. Priorytet pracy w trybie failover 0 wskazuje region zapisu. Maksymalna wartość priorytetu trybu failover = (całkowita liczba regionów — 1). Wartości priorytetów trybu failover muszą być unikatowe dla każdego z regionów, w których istnieje konto bazy danych. |
| begin |
W trybie offline określony region dla określonego konta bazy danych usługi Azure Cosmos DB. |
| begin |
W trybie offline określony region dla określonego konta bazy danych usługi Azure Cosmos DB. |
| begin |
Online określony region dla określonego konta bazy danych usługi Azure Cosmos DB. |
| begin |
Online określony region dla określonego konta bazy danych usługi Azure Cosmos DB. |
| begin |
Ponownie generuje klucz dostępu dla określonego konta bazy danych usługi Azure Cosmos DB. |
| begin |
Ponownie generuje klucz dostępu dla określonego konta bazy danych usługi Azure Cosmos DB. |
| begin |
Aktualizuje właściwości istniejącego konta bazy danych usługi Azure Cosmos DB. |
| begin |
Aktualizuje właściwości istniejącego konta bazy danych usługi Azure Cosmos DB. |
| check |
Sprawdza, czy nazwa konta usługi Azure Cosmos DB już istnieje. Prawidłowa nazwa konta może zawierać tylko małe litery, cyfry i znak "-" i musi zawierać od 3 do 50 znaków. |
| get(string, string, Database |
Pobiera właściwości istniejącego konta bazy danych usługi Azure Cosmos DB. |
| get |
Wyświetla listę kluczy dostępu tylko do odczytu dla określonego konta bazy danych usługi Azure Cosmos DB. |
| list(Database |
Wyświetla listę wszystkich kont bazy danych usługi Azure Cosmos DB dostępnych w ramach subskrypcji. |
| list |
Wyświetla listę wszystkich kont bazy danych usługi Azure Cosmos DB dostępnych w ramach danej grupy zasobów. |
| list |
Wyświetla listę parametrów połączenia dla określonego konta bazy danych usługi Azure Cosmos DB. |
| list |
Wyświetla listę kluczy dostępu dla określonego konta bazy danych usługi Azure Cosmos DB. |
| list |
Pobiera definicje metryk dla danego konta bazy danych. |
| list |
Pobiera metryki określone przez dany filtr dla danego konta bazy danych. |
| list |
Wyświetla listę kluczy dostępu tylko do odczytu dla określonego konta bazy danych usługi Azure Cosmos DB. |
| list |
Pobiera dane użycia (najnowsze dane) dla danego konta bazy danych. |
Szczegóły metody
beginCreateOrUpdate(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje konto bazy danych usługi Azure Cosmos DB. Metoda "Update" jest preferowana podczas przeprowadzania aktualizacji na koncie.
function beginCreateOrUpdate(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
Parametry, które mają być podane dla bieżącego konta bazy danych.
Parametry opcji.
Zwraca
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginCreateOrUpdateAndWait(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje konto bazy danych usługi Azure Cosmos DB. Metoda "Update" jest preferowana podczas przeprowadzania aktualizacji na koncie.
function beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<DatabaseAccountGetResults>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
Parametry, które mają być podane dla bieżącego konta bazy danych.
Parametry opcji.
Zwraca
Promise<DatabaseAccountGetResults>
beginDelete(string, string, DatabaseAccountsDeleteOptionalParams)
Usuwa istniejące konto bazy danych usługi Azure Cosmos DB.
function beginDelete(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
Parametry opcji.
Zwraca
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>
beginDeleteAndWait(string, string, DatabaseAccountsDeleteOptionalParams)
Usuwa istniejące konto bazy danych usługi Azure Cosmos DB.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<DatabaseAccountsDeleteHeaders>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
Parametry opcji.
Zwraca
Promise<DatabaseAccountsDeleteHeaders>
beginFailoverPriorityChange(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
Zmienia priorytet trybu failover dla konta bazy danych usługi Azure Cosmos DB. Priorytet pracy w trybie failover 0 wskazuje region zapisu. Maksymalna wartość priorytetu trybu failover = (całkowita liczba regionów — 1). Wartości priorytetów trybu failover muszą być unikatowe dla każdego z regionów, w których istnieje konto bazy danych.
function beginFailoverPriorityChange(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- failoverParameters
- FailoverPolicies
Nowe zasady trybu failover dla konta bazy danych.
Parametry opcji.
Zwraca
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>
beginFailoverPriorityChangeAndWait(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
Zmienia priorytet trybu failover dla konta bazy danych usługi Azure Cosmos DB. Priorytet pracy w trybie failover 0 wskazuje region zapisu. Maksymalna wartość priorytetu trybu failover = (całkowita liczba regionów — 1). Wartości priorytetów trybu failover muszą być unikatowe dla każdego z regionów, w których istnieje konto bazy danych.
function beginFailoverPriorityChangeAndWait(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<DatabaseAccountsFailoverPriorityChangeHeaders>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- failoverParameters
- FailoverPolicies
Nowe zasady trybu failover dla konta bazy danych.
Parametry opcji.
Zwraca
beginOfflineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
W trybie offline określony region dla określonego konta bazy danych usługi Azure Cosmos DB.
function beginOfflineRegion(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- regionParameterForOffline
- RegionForOnlineOffline
Region usługi Cosmos DB do trybu offline dla konta bazy danych.
Parametry opcji.
Zwraca
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOfflineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
W trybie offline określony region dla określonego konta bazy danych usługi Azure Cosmos DB.
function beginOfflineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- regionParameterForOffline
- RegionForOnlineOffline
Region usługi Cosmos DB do trybu offline dla konta bazy danych.
Parametry opcji.
Zwraca
Promise<void>
beginOnlineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
Online określony region dla określonego konta bazy danych usługi Azure Cosmos DB.
function beginOnlineRegion(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- regionParameterForOnline
- RegionForOnlineOffline
Region usługi Cosmos DB do trybu online dla konta bazy danych.
Parametry opcji.
Zwraca
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOnlineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
Online określony region dla określonego konta bazy danych usługi Azure Cosmos DB.
function beginOnlineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- regionParameterForOnline
- RegionForOnlineOffline
Region usługi Cosmos DB do trybu online dla konta bazy danych.
Parametry opcji.
Zwraca
Promise<void>
beginRegenerateKey(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
Ponownie generuje klucz dostępu dla określonego konta bazy danych usługi Azure Cosmos DB.
function beginRegenerateKey(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
Nazwa klucza do ponownego wygenerowania.
Parametry opcji.
Zwraca
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRegenerateKeyAndWait(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
Ponownie generuje klucz dostępu dla określonego konta bazy danych usługi Azure Cosmos DB.
function beginRegenerateKeyAndWait(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
Nazwa klucza do ponownego wygenerowania.
Parametry opcji.
Zwraca
Promise<void>
beginUpdate(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
Aktualizuje właściwości istniejącego konta bazy danych usługi Azure Cosmos DB.
function beginUpdate(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- updateParameters
- DatabaseAccountUpdateParameters
Parametry, które mają być podane dla bieżącego konta bazy danych.
Parametry opcji.
Zwraca
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginUpdateAndWait(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
Aktualizuje właściwości istniejącego konta bazy danych usługi Azure Cosmos DB.
function beginUpdateAndWait(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<DatabaseAccountGetResults>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- updateParameters
- DatabaseAccountUpdateParameters
Parametry, które mają być podane dla bieżącego konta bazy danych.
Parametry opcji.
Zwraca
Promise<DatabaseAccountGetResults>
checkNameExists(string, DatabaseAccountsCheckNameExistsOptionalParams)
Sprawdza, czy nazwa konta usługi Azure Cosmos DB już istnieje. Prawidłowa nazwa konta może zawierać tylko małe litery, cyfry i znak "-" i musi zawierać od 3 do 50 znaków.
function checkNameExists(accountName: string, options?: DatabaseAccountsCheckNameExistsOptionalParams): Promise<DatabaseAccountsCheckNameExistsResponse>
Parametry
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
Parametry opcji.
Zwraca
get(string, string, DatabaseAccountsGetOptionalParams)
Pobiera właściwości istniejącego konta bazy danych usługi Azure Cosmos DB.
function get(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetOptionalParams): Promise<DatabaseAccountGetResults>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
Parametry opcji.
Zwraca
Promise<DatabaseAccountGetResults>
getReadOnlyKeys(string, string, DatabaseAccountsGetReadOnlyKeysOptionalParams)
Wyświetla listę kluczy dostępu tylko do odczytu dla określonego konta bazy danych usługi Azure Cosmos DB.
function getReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
Parametry opcji.
Zwraca
list(DatabaseAccountsListOptionalParams)
Wyświetla listę wszystkich kont bazy danych usługi Azure Cosmos DB dostępnych w ramach subskrypcji.
function list(options?: DatabaseAccountsListOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>
Parametry
Parametry opcji.
Zwraca
listByResourceGroup(string, DatabaseAccountsListByResourceGroupOptionalParams)
Wyświetla listę wszystkich kont bazy danych usługi Azure Cosmos DB dostępnych w ramach danej grupy zasobów.
function listByResourceGroup(resourceGroupName: string, options?: DatabaseAccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
Parametry opcji.
Zwraca
listConnectionStrings(string, string, DatabaseAccountsListConnectionStringsOptionalParams)
Wyświetla listę parametrów połączenia dla określonego konta bazy danych usługi Azure Cosmos DB.
function listConnectionStrings(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListConnectionStringsOptionalParams): Promise<DatabaseAccountListConnectionStringsResult>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
Parametry opcji.
Zwraca
listKeys(string, string, DatabaseAccountsListKeysOptionalParams)
Wyświetla listę kluczy dostępu dla określonego konta bazy danych usługi Azure Cosmos DB.
function listKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListKeysOptionalParams): Promise<DatabaseAccountListKeysResult>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
Parametry opcji.
Zwraca
Promise<DatabaseAccountListKeysResult>
listMetricDefinitions(string, string, DatabaseAccountsListMetricDefinitionsOptionalParams)
Pobiera definicje metryk dla danego konta bazy danych.
function listMetricDefinitions(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
Parametry opcji.
Zwraca
listMetrics(string, string, string, DatabaseAccountsListMetricsOptionalParams)
Pobiera metryki określone przez dany filtr dla danego konta bazy danych.
function listMetrics(resourceGroupName: string, accountName: string, filter: string, options?: DatabaseAccountsListMetricsOptionalParams): PagedAsyncIterableIterator<Metric, Metric[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
- filter
-
string
Wyrażenie filtru OData, które opisuje podzestaw metryk do zwrócenia. Parametry, które można filtrować, to name.value (nazwa metryki, może mieć wiele nazw), startTime, endTime i timeGrain. Obsługiwany operator to eq.
Parametry opcji.
Zwraca
listReadOnlyKeys(string, string, DatabaseAccountsListReadOnlyKeysOptionalParams)
Wyświetla listę kluczy dostępu tylko do odczytu dla określonego konta bazy danych usługi Azure Cosmos DB.
function listReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
Parametry opcji.
Zwraca
listUsages(string, string, DatabaseAccountsListUsagesOptionalParams)
Pobiera dane użycia (najnowsze dane) dla danego konta bazy danych.
function listUsages(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListUsagesOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- accountName
-
string
Nazwa konta bazy danych usługi Cosmos DB.
Parametry opcji.