DatabaseAccounts interface
Интерфейс, представляющий DatabaseAccounts.
Методы
| begin |
Создает или обновляет учетную запись базы данных Azure Cosmos DB. Метод Update предпочтителен при выполнении обновлений в учетной записи. |
| begin |
Создает или обновляет учетную запись базы данных Azure Cosmos DB. Метод Update предпочтителен при выполнении обновлений в учетной записи. |
| begin |
Удаляет существующую учетную запись базы данных Azure Cosmos DB. |
| begin |
Удаляет существующую учетную запись базы данных Azure Cosmos DB. |
| begin |
Изменяет приоритет отработки отказа для учетной записи базы данных Azure Cosmos DB. Приоритет отработки отказа 0 указывает регион записи. Максимальное значение для приоритета отработки отказа = (общее число регионов - 1). Значения приоритета отработки отказа должны быть уникальными для каждого региона, в котором существует учетная запись базы данных. |
| begin |
Изменяет приоритет отработки отказа для учетной записи базы данных Azure Cosmos DB. Приоритет отработки отказа 0 указывает регион записи. Максимальное значение для приоритета отработки отказа = (общее число регионов - 1). Значения приоритета отработки отказа должны быть уникальными для каждого региона, в котором существует учетная запись базы данных. |
| begin |
Автономный указанный регион для указанной учетной записи базы данных Azure Cosmos DB. |
| begin |
Автономный указанный регион для указанной учетной записи базы данных Azure Cosmos DB. |
| begin |
В сети указан регион для указанной учетной записи базы данных Azure Cosmos DB. |
| begin |
В сети указан регион для указанной учетной записи базы данных Azure Cosmos DB. |
| begin |
Повторно создает ключ доступа для указанной учетной записи базы данных Azure Cosmos DB. |
| begin |
Повторно создает ключ доступа для указанной учетной записи базы данных Azure Cosmos DB. |
| begin |
Обновляет свойства существующей учетной записи базы данных Azure Cosmos DB. |
| begin |
Обновляет свойства существующей учетной записи базы данных Azure Cosmos DB. |
| check |
Проверяет, существует ли имя учетной записи Azure Cosmos DB. Допустимое имя учетной записи может содержать только строчные буквы, цифры и символ "-" и должно быть от 3 до 50 символов. |
| get(string, string, Database |
Извлекает свойства существующей учетной записи базы данных Azure Cosmos DB. |
| get |
Выводит список ключей доступа только для чтения для указанной учетной записи базы данных Azure Cosmos DB. |
| list(Database |
Выводит список всех учетных записей базы данных Azure Cosmos DB, доступных в подписке. |
| list |
Выводит список всех учетных записей базы данных Azure Cosmos DB, доступных в данной группе ресурсов. |
| list |
Выводит строки подключения для указанной учетной записи базы данных Azure Cosmos DB. |
| list |
Выводит список ключей доступа для указанной учетной записи базы данных Azure Cosmos DB. |
| list |
Извлекает определения метрик для данной учетной записи базы данных. |
| list |
Извлекает метрики, определенные заданным фильтром для данной учетной записи базы данных. |
| list |
Выводит список ключей доступа только для чтения для указанной учетной записи базы данных Azure Cosmos DB. |
| list |
Извлекает данные об использовании (последние данные) для данной учетной записи базы данных. |
Сведения о методе
beginCreateOrUpdate(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Создает или обновляет учетную запись базы данных Azure Cosmos DB. Метод Update предпочтителен при выполнении обновлений в учетной записи.
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. Метод Update предпочтителен при выполнении обновлений в учетной записи.
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.
Параметры параметров.