DatabaseAccounts interface
Gränssnitt som representerar ett DatabaseAccounts.
Metoder
| begin |
Skapar eller uppdaterar ett Azure Cosmos DB-databaskonto. Metoden "Uppdatera" rekommenderas när du utför uppdateringar på ett konto. |
| begin |
Skapar eller uppdaterar ett Azure Cosmos DB-databaskonto. Metoden "Uppdatera" rekommenderas när du utför uppdateringar på ett konto. |
| begin |
Tar bort ett befintligt Azure Cosmos DB-databaskonto. |
| begin |
Tar bort ett befintligt Azure Cosmos DB-databaskonto. |
| begin |
Ändrar redundansprioriteten för Azure Cosmos DB-databaskontot. En redundansprioritet på 0 anger en skrivregion. Det maximala värdet för en redundansprioritet = (totalt antal regioner - 1). Prioritetsvärden för redundans måste vara unika för var och en av de regioner där databaskontot finns. |
| begin |
Ändrar redundansprioriteten för Azure Cosmos DB-databaskontot. En redundansprioritet på 0 anger en skrivregion. Det maximala värdet för en redundansprioritet = (totalt antal regioner - 1). Prioritetsvärden för redundans måste vara unika för var och en av de regioner där databaskontot finns. |
| begin |
Offline den angivna regionen för det angivna Azure Cosmos DB-databaskontot. |
| begin |
Offline den angivna regionen för det angivna Azure Cosmos DB-databaskontot. |
| begin |
Online den angivna regionen för det angivna Azure Cosmos DB-databaskontot. |
| begin |
Online den angivna regionen för det angivna Azure Cosmos DB-databaskontot. |
| begin |
Återskapar en åtkomstnyckel för det angivna Azure Cosmos DB-databaskontot. |
| begin |
Återskapar en åtkomstnyckel för det angivna Azure Cosmos DB-databaskontot. |
| begin |
Uppdaterar egenskaperna för ett befintligt Azure Cosmos DB-databaskonto. |
| begin |
Uppdaterar egenskaperna för ett befintligt Azure Cosmos DB-databaskonto. |
| check |
Kontrollerar att Azure Cosmos DB-kontonamnet redan finns. Ett giltigt kontonamn får endast innehålla gemener, siffror och -tecknet och måste vara mellan 3 och 50 tecken. |
| get(string, string, Database |
Hämtar egenskaperna för ett befintligt Azure Cosmos DB-databaskonto. |
| get |
Visar en lista över skrivskyddade åtkomstnycklar för det angivna Azure Cosmos DB-databaskontot. |
| list(Database |
Visar en lista över alla Azure Cosmos DB-databaskonton som är tillgängliga under prenumerationen. |
| list |
Visar en lista över alla Azure Cosmos DB-databaskonton som är tillgängliga under den angivna resursgruppen. |
| list |
Visar en lista över anslutningssträngarna för det angivna Azure Cosmos DB-databaskontot. |
| list |
Visar en lista över åtkomstnycklarna för det angivna Azure Cosmos DB-databaskontot. |
| list |
Hämtar måttdefinitioner för det angivna databaskontot. |
| list |
Hämtar de mått som bestäms av det angivna filtret för det angivna databaskontot. |
| list |
Visar en lista över skrivskyddade åtkomstnycklar för det angivna Azure Cosmos DB-databaskontot. |
| list |
Hämtar användningarna (senaste data) för det angivna databaskontot. |
Metodinformation
beginCreateOrUpdate(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Skapar eller uppdaterar ett Azure Cosmos DB-databaskonto. Metoden "Uppdatera" rekommenderas när du utför uppdateringar på ett konto.
function beginCreateOrUpdate(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
Parametrarna som ska anges för det aktuella databaskontot.
Alternativparametrarna.
Returer
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginCreateOrUpdateAndWait(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Skapar eller uppdaterar ett Azure Cosmos DB-databaskonto. Metoden "Uppdatera" rekommenderas när du utför uppdateringar på ett konto.
function beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<DatabaseAccountGetResults>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
Parametrarna som ska anges för det aktuella databaskontot.
Alternativparametrarna.
Returer
Promise<DatabaseAccountGetResults>
beginDelete(string, string, DatabaseAccountsDeleteOptionalParams)
Tar bort ett befintligt Azure Cosmos DB-databaskonto.
function beginDelete(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
Alternativparametrarna.
Returer
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>
beginDeleteAndWait(string, string, DatabaseAccountsDeleteOptionalParams)
Tar bort ett befintligt Azure Cosmos DB-databaskonto.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<DatabaseAccountsDeleteHeaders>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
Alternativparametrarna.
Returer
Promise<DatabaseAccountsDeleteHeaders>
beginFailoverPriorityChange(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
Ändrar redundansprioriteten för Azure Cosmos DB-databaskontot. En redundansprioritet på 0 anger en skrivregion. Det maximala värdet för en redundansprioritet = (totalt antal regioner - 1). Prioritetsvärden för redundans måste vara unika för var och en av de regioner där databaskontot finns.
function beginFailoverPriorityChange(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- failoverParameters
- FailoverPolicies
De nya redundansprinciperna för databaskontot.
Alternativparametrarna.
Returer
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>
beginFailoverPriorityChangeAndWait(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
Ändrar redundansprioriteten för Azure Cosmos DB-databaskontot. En redundansprioritet på 0 anger en skrivregion. Det maximala värdet för en redundansprioritet = (totalt antal regioner - 1). Prioritetsvärden för redundans måste vara unika för var och en av de regioner där databaskontot finns.
function beginFailoverPriorityChangeAndWait(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<DatabaseAccountsFailoverPriorityChangeHeaders>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- failoverParameters
- FailoverPolicies
De nya redundansprinciperna för databaskontot.
Alternativparametrarna.
Returer
beginOfflineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
Offline den angivna regionen för det angivna Azure Cosmos DB-databaskontot.
function beginOfflineRegion(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- regionParameterForOffline
- RegionForOnlineOffline
Cosmos DB-regionen till offline för databaskontot.
Alternativparametrarna.
Returer
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOfflineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
Offline den angivna regionen för det angivna Azure Cosmos DB-databaskontot.
function beginOfflineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<void>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- regionParameterForOffline
- RegionForOnlineOffline
Cosmos DB-regionen till offline för databaskontot.
Alternativparametrarna.
Returer
Promise<void>
beginOnlineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
Online den angivna regionen för det angivna Azure Cosmos DB-databaskontot.
function beginOnlineRegion(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- regionParameterForOnline
- RegionForOnlineOffline
Cosmos DB-region till online för databaskontot.
Alternativparametrarna.
Returer
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOnlineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
Online den angivna regionen för det angivna Azure Cosmos DB-databaskontot.
function beginOnlineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<void>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- regionParameterForOnline
- RegionForOnlineOffline
Cosmos DB-region till online för databaskontot.
Alternativparametrarna.
Returer
Promise<void>
beginRegenerateKey(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
Återskapar en åtkomstnyckel för det angivna Azure Cosmos DB-databaskontot.
function beginRegenerateKey(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
Namnet på nyckeln som ska återskapas.
Alternativparametrarna.
Returer
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRegenerateKeyAndWait(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
Återskapar en åtkomstnyckel för det angivna Azure Cosmos DB-databaskontot.
function beginRegenerateKeyAndWait(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<void>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
Namnet på nyckeln som ska återskapas.
Alternativparametrarna.
Returer
Promise<void>
beginUpdate(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
Uppdaterar egenskaperna för ett befintligt Azure Cosmos DB-databaskonto.
function beginUpdate(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- updateParameters
- DatabaseAccountUpdateParameters
Parametrarna som ska anges för det aktuella databaskontot.
Alternativparametrarna.
Returer
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginUpdateAndWait(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
Uppdaterar egenskaperna för ett befintligt Azure Cosmos DB-databaskonto.
function beginUpdateAndWait(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<DatabaseAccountGetResults>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- updateParameters
- DatabaseAccountUpdateParameters
Parametrarna som ska anges för det aktuella databaskontot.
Alternativparametrarna.
Returer
Promise<DatabaseAccountGetResults>
checkNameExists(string, DatabaseAccountsCheckNameExistsOptionalParams)
Kontrollerar att Azure Cosmos DB-kontonamnet redan finns. Ett giltigt kontonamn får endast innehålla gemener, siffror och -tecknet och måste vara mellan 3 och 50 tecken.
function checkNameExists(accountName: string, options?: DatabaseAccountsCheckNameExistsOptionalParams): Promise<DatabaseAccountsCheckNameExistsResponse>
Parametrar
- accountName
-
string
Cosmos DB-databaskontonamn.
Alternativparametrarna.
Returer
get(string, string, DatabaseAccountsGetOptionalParams)
Hämtar egenskaperna för ett befintligt Azure Cosmos DB-databaskonto.
function get(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetOptionalParams): Promise<DatabaseAccountGetResults>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
Alternativparametrarna.
Returer
Promise<DatabaseAccountGetResults>
getReadOnlyKeys(string, string, DatabaseAccountsGetReadOnlyKeysOptionalParams)
Visar en lista över skrivskyddade åtkomstnycklar för det angivna Azure Cosmos DB-databaskontot.
function getReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
Alternativparametrarna.
Returer
list(DatabaseAccountsListOptionalParams)
Visar en lista över alla Azure Cosmos DB-databaskonton som är tillgängliga under prenumerationen.
function list(options?: DatabaseAccountsListOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>
Parametrar
Alternativparametrarna.
Returer
listByResourceGroup(string, DatabaseAccountsListByResourceGroupOptionalParams)
Visar en lista över alla Azure Cosmos DB-databaskonton som är tillgängliga under den angivna resursgruppen.
function listByResourceGroup(resourceGroupName: string, options?: DatabaseAccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
Alternativparametrarna.
Returer
listConnectionStrings(string, string, DatabaseAccountsListConnectionStringsOptionalParams)
Visar en lista över anslutningssträngarna för det angivna Azure Cosmos DB-databaskontot.
function listConnectionStrings(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListConnectionStringsOptionalParams): Promise<DatabaseAccountListConnectionStringsResult>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
Alternativparametrarna.
Returer
listKeys(string, string, DatabaseAccountsListKeysOptionalParams)
Visar en lista över åtkomstnycklarna för det angivna Azure Cosmos DB-databaskontot.
function listKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListKeysOptionalParams): Promise<DatabaseAccountListKeysResult>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
Alternativparametrarna.
Returer
Promise<DatabaseAccountListKeysResult>
listMetricDefinitions(string, string, DatabaseAccountsListMetricDefinitionsOptionalParams)
Hämtar måttdefinitioner för det angivna databaskontot.
function listMetricDefinitions(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
Alternativparametrarna.
Returer
listMetrics(string, string, string, DatabaseAccountsListMetricsOptionalParams)
Hämtar de mått som bestäms av det angivna filtret för det angivna databaskontot.
function listMetrics(resourceGroupName: string, accountName: string, filter: string, options?: DatabaseAccountsListMetricsOptionalParams): PagedAsyncIterableIterator<Metric, Metric[], PageSettings>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
- filter
-
string
Ett OData-filteruttryck som beskriver en delmängd mått som ska returneras. Parametrarna som kan filtreras är name.value (måttets namn, kan ha ett eller flera namn), startTime, endTime och timeGrain. Operatorn som stöds är eq.
Alternativparametrarna.
Returer
listReadOnlyKeys(string, string, DatabaseAccountsListReadOnlyKeysOptionalParams)
Visar en lista över skrivskyddade åtkomstnycklar för det angivna Azure Cosmos DB-databaskontot.
function listReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
Alternativparametrarna.
Returer
listUsages(string, string, DatabaseAccountsListUsagesOptionalParams)
Hämtar användningarna (senaste data) för det angivna databaskontot.
function listUsages(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListUsagesOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], PageSettings>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- accountName
-
string
Cosmos DB-databaskontonamn.
Alternativparametrarna.