DatabaseAccounts interface
Rozhraní představující databaseAccounts.
Metody
| begin |
Vytvoří nebo aktualizuje účet databáze Azure Cosmos DB. Při provádění aktualizací v účtu se upřednostňuje metoda Update. |
| begin |
Vytvoří nebo aktualizuje účet databáze Azure Cosmos DB. Při provádění aktualizací v účtu se upřednostňuje metoda Update. |
| begin |
Odstraní existující účet databáze Azure Cosmos DB. |
| begin |
Odstraní existující účet databáze Azure Cosmos DB. |
| begin |
Změní prioritu převzetí služeb při selhání pro účet databáze Azure Cosmos DB. Priorita převzetí služeb při selhání 0 označuje oblast zápisu. Maximální hodnota priority převzetí služeb při selhání = (celkový počet oblastí – 1). Hodnoty priority převzetí služeb při selhání musí být jedinečné pro každou z oblastí, ve kterých existuje databázový účet. |
| begin |
Změní prioritu převzetí služeb při selhání pro účet databáze Azure Cosmos DB. Priorita převzetí služeb při selhání 0 označuje oblast zápisu. Maximální hodnota priority převzetí služeb při selhání = (celkový počet oblastí – 1). Hodnoty priority převzetí služeb při selhání musí být jedinečné pro každou z oblastí, ve kterých existuje databázový účet. |
| begin |
Offline zadaná oblast pro zadaný účet databáze Azure Cosmos DB. |
| begin |
Offline zadaná oblast pro zadaný účet databáze Azure Cosmos DB. |
| begin |
Online zadanou oblast pro zadaný účet databáze Azure Cosmos DB. |
| begin |
Online zadanou oblast pro zadaný účet databáze Azure Cosmos DB. |
| begin |
Znovu vygeneruje přístupový klíč pro zadaný účet databáze Azure Cosmos DB. |
| begin |
Znovu vygeneruje přístupový klíč pro zadaný účet databáze Azure Cosmos DB. |
| begin |
Aktualizuje vlastnosti existujícího databázového účtu služby Azure Cosmos DB. |
| begin |
Aktualizuje vlastnosti existujícího databázového účtu služby Azure Cosmos DB. |
| check |
Zkontroluje, že název účtu služby Azure Cosmos DB již existuje. Platný název účtu může obsahovat pouze malá písmena, číslice a znak "-" a musí mít délku 3 až 50 znaků. |
| get(string, string, Database |
Načte vlastnosti existujícího databázového účtu služby Azure Cosmos DB. |
| get |
Zobrazí seznam přístupových klíčů jen pro čtení pro zadaný účet databáze Azure Cosmos DB. |
| list(Database |
Zobrazí seznam všech účtů databáze Azure Cosmos DB dostupných v rámci předplatného. |
| list |
Zobrazí seznam všech účtů databáze Azure Cosmos DB dostupných v dané skupině prostředků. |
| list |
Zobrazí seznam připojovacích řetězců pro zadaný účet databáze Azure Cosmos DB. |
| list |
Zobrazí seznam přístupových klíčů pro zadaný účet databáze Azure Cosmos DB. |
| list |
Načte definice metrik pro daný databázový účet. |
| list |
Načte metriky určené daným filtrem pro daný databázový účet. |
| list |
Zobrazí seznam přístupových klíčů jen pro čtení pro zadaný účet databáze Azure Cosmos DB. |
| list |
Načte využití (nejnovější data) pro daný databázový účet. |
Podrobnosti metody
beginCreateOrUpdate(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Vytvoří nebo aktualizuje účet databáze Azure Cosmos DB. Při provádění aktualizací v účtu se upřednostňuje metoda Update.
function beginCreateOrUpdate(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
Parametry, které se mají poskytnout pro aktuální účet databáze.
Parametry možností.
Návraty
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginCreateOrUpdateAndWait(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Vytvoří nebo aktualizuje účet databáze Azure Cosmos DB. Při provádění aktualizací v účtu se upřednostňuje metoda Update.
function beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<DatabaseAccountGetResults>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
Parametry, které se mají poskytnout pro aktuální účet databáze.
Parametry možností.
Návraty
Promise<DatabaseAccountGetResults>
beginDelete(string, string, DatabaseAccountsDeleteOptionalParams)
Odstraní existující účet databáze Azure Cosmos DB.
function beginDelete(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
Parametry možností.
Návraty
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>
beginDeleteAndWait(string, string, DatabaseAccountsDeleteOptionalParams)
Odstraní existující účet databáze Azure Cosmos DB.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<DatabaseAccountsDeleteHeaders>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
Parametry možností.
Návraty
Promise<DatabaseAccountsDeleteHeaders>
beginFailoverPriorityChange(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
Změní prioritu převzetí služeb při selhání pro účet databáze Azure Cosmos DB. Priorita převzetí služeb při selhání 0 označuje oblast zápisu. Maximální hodnota priority převzetí služeb při selhání = (celkový počet oblastí – 1). Hodnoty priority převzetí služeb při selhání musí být jedinečné pro každou z oblastí, ve kterých existuje databázový účet.
function beginFailoverPriorityChange(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- failoverParameters
- FailoverPolicies
Nové zásady převzetí služeb při selhání pro databázový účet.
Parametry možností.
Návraty
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>
beginFailoverPriorityChangeAndWait(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
Změní prioritu převzetí služeb při selhání pro účet databáze Azure Cosmos DB. Priorita převzetí služeb při selhání 0 označuje oblast zápisu. Maximální hodnota priority převzetí služeb při selhání = (celkový počet oblastí – 1). Hodnoty priority převzetí služeb při selhání musí být jedinečné pro každou z oblastí, ve kterých existuje databázový účet.
function beginFailoverPriorityChangeAndWait(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<DatabaseAccountsFailoverPriorityChangeHeaders>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- failoverParameters
- FailoverPolicies
Nové zásady převzetí služeb při selhání pro databázový účet.
Parametry možností.
Návraty
beginOfflineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
Offline zadaná oblast pro zadaný účet databáze Azure Cosmos DB.
function beginOfflineRegion(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- regionParameterForOffline
- RegionForOnlineOffline
Oblast Cosmos DB do offline režimu pro účet databáze.
Parametry možností.
Návraty
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOfflineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
Offline zadaná oblast pro zadaný účet databáze Azure Cosmos DB.
function beginOfflineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- regionParameterForOffline
- RegionForOnlineOffline
Oblast Cosmos DB do offline režimu pro účet databáze.
Parametry možností.
Návraty
Promise<void>
beginOnlineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
Online zadanou oblast pro zadaný účet databáze Azure Cosmos DB.
function beginOnlineRegion(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- regionParameterForOnline
- RegionForOnlineOffline
Oblast Cosmos DB je pro účet databáze online.
Parametry možností.
Návraty
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOnlineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
Online zadanou oblast pro zadaný účet databáze Azure Cosmos DB.
function beginOnlineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- regionParameterForOnline
- RegionForOnlineOffline
Oblast Cosmos DB je pro účet databáze online.
Parametry možností.
Návraty
Promise<void>
beginRegenerateKey(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
Znovu vygeneruje přístupový klíč pro zadaný účet databáze Azure Cosmos DB.
function beginRegenerateKey(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
Název klíče, který se má znovu vygenerovat.
Parametry možností.
Návraty
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRegenerateKeyAndWait(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
Znovu vygeneruje přístupový klíč pro zadaný účet databáze Azure Cosmos DB.
function beginRegenerateKeyAndWait(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
Název klíče, který se má znovu vygenerovat.
Parametry možností.
Návraty
Promise<void>
beginUpdate(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
Aktualizuje vlastnosti existujícího databázového účtu služby Azure Cosmos DB.
function beginUpdate(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- updateParameters
- DatabaseAccountUpdateParameters
Parametry, které se mají poskytnout pro aktuální účet databáze.
Parametry možností.
Návraty
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginUpdateAndWait(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
Aktualizuje vlastnosti existujícího databázového účtu služby Azure Cosmos DB.
function beginUpdateAndWait(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<DatabaseAccountGetResults>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- updateParameters
- DatabaseAccountUpdateParameters
Parametry, které se mají poskytnout pro aktuální účet databáze.
Parametry možností.
Návraty
Promise<DatabaseAccountGetResults>
checkNameExists(string, DatabaseAccountsCheckNameExistsOptionalParams)
Zkontroluje, že název účtu služby Azure Cosmos DB již existuje. Platný název účtu může obsahovat pouze malá písmena, číslice a znak "-" a musí mít délku 3 až 50 znaků.
function checkNameExists(accountName: string, options?: DatabaseAccountsCheckNameExistsOptionalParams): Promise<DatabaseAccountsCheckNameExistsResponse>
Parametry
- accountName
-
string
Název databázového účtu služby Cosmos DB.
Parametry možností.
Návraty
get(string, string, DatabaseAccountsGetOptionalParams)
Načte vlastnosti existujícího databázového účtu služby Azure Cosmos DB.
function get(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetOptionalParams): Promise<DatabaseAccountGetResults>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
Parametry možností.
Návraty
Promise<DatabaseAccountGetResults>
getReadOnlyKeys(string, string, DatabaseAccountsGetReadOnlyKeysOptionalParams)
Zobrazí seznam přístupových klíčů jen pro čtení pro zadaný účet databáze Azure Cosmos DB.
function getReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
Parametry možností.
Návraty
list(DatabaseAccountsListOptionalParams)
Zobrazí seznam všech účtů databáze Azure Cosmos DB dostupných v rámci předplatného.
function list(options?: DatabaseAccountsListOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>
Parametry
Parametry možností.
Návraty
listByResourceGroup(string, DatabaseAccountsListByResourceGroupOptionalParams)
Zobrazí seznam všech účtů databáze Azure Cosmos DB dostupných v dané skupině prostředků.
function listByResourceGroup(resourceGroupName: string, options?: DatabaseAccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
Parametry možností.
Návraty
listConnectionStrings(string, string, DatabaseAccountsListConnectionStringsOptionalParams)
Zobrazí seznam připojovacích řetězců pro zadaný účet databáze Azure Cosmos DB.
function listConnectionStrings(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListConnectionStringsOptionalParams): Promise<DatabaseAccountListConnectionStringsResult>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
Parametry možností.
Návraty
listKeys(string, string, DatabaseAccountsListKeysOptionalParams)
Zobrazí seznam přístupových klíčů pro zadaný účet databáze Azure Cosmos DB.
function listKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListKeysOptionalParams): Promise<DatabaseAccountListKeysResult>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
Parametry možností.
Návraty
Promise<DatabaseAccountListKeysResult>
listMetricDefinitions(string, string, DatabaseAccountsListMetricDefinitionsOptionalParams)
Načte definice metrik pro daný databázový účet.
function listMetricDefinitions(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
Parametry možností.
Návraty
listMetrics(string, string, string, DatabaseAccountsListMetricsOptionalParams)
Načte metriky určené daným filtrem pro daný databázový účet.
function listMetrics(resourceGroupName: string, accountName: string, filter: string, options?: DatabaseAccountsListMetricsOptionalParams): PagedAsyncIterableIterator<Metric, Metric[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
- filter
-
string
Výraz filtru OData, který popisuje podmnožinu metrik, které se mají vrátit. Parametry, které lze filtrovat, jsou name.value (název metriky, může mít nebo více názvů), startTime, endTime a timeGrain. Podporovaný operátor je eq.
Parametry možností.
Návraty
listReadOnlyKeys(string, string, DatabaseAccountsListReadOnlyKeysOptionalParams)
Zobrazí seznam přístupových klíčů jen pro čtení pro zadaný účet databáze Azure Cosmos DB.
function listReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
Parametry možností.
Návraty
listUsages(string, string, DatabaseAccountsListUsagesOptionalParams)
Načte využití (nejnovější data) pro daný databázový účet.
function listUsages(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListUsagesOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- accountName
-
string
Název databázového účtu služby Cosmos DB.
Parametry možností.