DatabaseAccounts interface
Interface représentant un DatabaseAccounts.
Méthodes
| begin |
Crée ou met à jour un compte de base de données Azure Cosmos DB. La méthode « Update » est préférée lors de l’exécution de mises à jour sur un compte. |
| begin |
Crée ou met à jour un compte de base de données Azure Cosmos DB. La méthode « Update » est préférée lors de l’exécution de mises à jour sur un compte. |
| begin |
Supprime un compte de base de données Azure Cosmos DB existant. |
| begin |
Supprime un compte de base de données Azure Cosmos DB existant. |
| begin |
Modifie la priorité de basculement pour le compte de base de données Azure Cosmos DB. Une priorité de basculement de 0 indique une région d’écriture. Valeur maximale d’une priorité de basculement = (nombre total de régions - 1). Les valeurs de priorité de basculement doivent être uniques pour chacune des régions dans lesquelles le compte de base de données existe. |
| begin |
Modifie la priorité de basculement pour le compte de base de données Azure Cosmos DB. Une priorité de basculement de 0 indique une région d’écriture. Valeur maximale d’une priorité de basculement = (nombre total de régions - 1). Les valeurs de priorité de basculement doivent être uniques pour chacune des régions dans lesquelles le compte de base de données existe. |
| begin |
Hors connexion de la région spécifiée pour le compte de base de données Azure Cosmos DB spécifié. |
| begin |
Hors connexion de la région spécifiée pour le compte de base de données Azure Cosmos DB spécifié. |
| begin |
En ligne la région spécifiée pour le compte de base de données Azure Cosmos DB spécifié. |
| begin |
En ligne la région spécifiée pour le compte de base de données Azure Cosmos DB spécifié. |
| begin |
Régénère une clé d’accès pour le compte de base de données Azure Cosmos DB spécifié. |
| begin |
Régénère une clé d’accès pour le compte de base de données Azure Cosmos DB spécifié. |
| begin |
Met à jour les propriétés d’un compte de base de données Azure Cosmos DB existant. |
| begin |
Met à jour les propriétés d’un compte de base de données Azure Cosmos DB existant. |
| check |
Vérifie que le nom du compte Azure Cosmos DB existe déjà. Un nom de compte valide peut contenir uniquement des lettres minuscules, des chiffres et le caractère « - », et doit être compris entre 3 et 50 caractères. |
| get(string, string, Database |
Récupère les propriétés d’un compte de base de données Azure Cosmos DB existant. |
| get |
Répertorie les clés d’accès en lecture seule pour le compte de base de données Azure Cosmos DB spécifié. |
| list(Database |
Répertorie tous les comptes de base de données Azure Cosmos DB disponibles sous l’abonnement. |
| list |
Répertorie tous les comptes de base de données Azure Cosmos DB disponibles sous le groupe de ressources donné. |
| list |
Répertorie les chaînes de connexion pour le compte de base de données Azure Cosmos DB spécifié. |
| list |
Répertorie les clés d’accès pour le compte de base de données Azure Cosmos DB spécifié. |
| list |
Récupère les définitions de métriques pour le compte de base de données donné. |
| list |
Récupère les métriques déterminées par le filtre donné pour le compte de base de données donné. |
| list |
Répertorie les clés d’accès en lecture seule pour le compte de base de données Azure Cosmos DB spécifié. |
| list |
Récupère les utilisations (données les plus récentes) pour le compte de base de données donné. |
Détails de la méthode
beginCreateOrUpdate(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Crée ou met à jour un compte de base de données Azure Cosmos DB. La méthode « Update » est préférée lors de l’exécution de mises à jour sur un compte.
function beginCreateOrUpdate(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
Paramètres à fournir pour le compte de base de données actuel.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginCreateOrUpdateAndWait(string, string, DatabaseAccountCreateUpdateParameters, DatabaseAccountsCreateOrUpdateOptionalParams)
Crée ou met à jour un compte de base de données Azure Cosmos DB. La méthode « Update » est préférée lors de l’exécution de mises à jour sur un compte.
function beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, createUpdateParameters: DatabaseAccountCreateUpdateParameters, options?: DatabaseAccountsCreateOrUpdateOptionalParams): Promise<DatabaseAccountGetResults>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- createUpdateParameters
- DatabaseAccountCreateUpdateParameters
Paramètres à fournir pour le compte de base de données actuel.
Paramètres d’options.
Retours
Promise<DatabaseAccountGetResults>
beginDelete(string, string, DatabaseAccountsDeleteOptionalParams)
Supprime un compte de base de données Azure Cosmos DB existant.
function beginDelete(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsDeleteHeaders>, DatabaseAccountsDeleteHeaders>>
beginDeleteAndWait(string, string, DatabaseAccountsDeleteOptionalParams)
Supprime un compte de base de données Azure Cosmos DB existant.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: DatabaseAccountsDeleteOptionalParams): Promise<DatabaseAccountsDeleteHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
Paramètres d’options.
Retours
Promise<DatabaseAccountsDeleteHeaders>
beginFailoverPriorityChange(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
Modifie la priorité de basculement pour le compte de base de données Azure Cosmos DB. Une priorité de basculement de 0 indique une région d’écriture. Valeur maximale d’une priorité de basculement = (nombre total de régions - 1). Les valeurs de priorité de basculement doivent être uniques pour chacune des régions dans lesquelles le compte de base de données existe.
function beginFailoverPriorityChange(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- failoverParameters
- FailoverPolicies
Nouvelles stratégies de basculement pour le compte de base de données.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountsFailoverPriorityChangeHeaders>, DatabaseAccountsFailoverPriorityChangeHeaders>>
beginFailoverPriorityChangeAndWait(string, string, FailoverPolicies, DatabaseAccountsFailoverPriorityChangeOptionalParams)
Modifie la priorité de basculement pour le compte de base de données Azure Cosmos DB. Une priorité de basculement de 0 indique une région d’écriture. Valeur maximale d’une priorité de basculement = (nombre total de régions - 1). Les valeurs de priorité de basculement doivent être uniques pour chacune des régions dans lesquelles le compte de base de données existe.
function beginFailoverPriorityChangeAndWait(resourceGroupName: string, accountName: string, failoverParameters: FailoverPolicies, options?: DatabaseAccountsFailoverPriorityChangeOptionalParams): Promise<DatabaseAccountsFailoverPriorityChangeHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- failoverParameters
- FailoverPolicies
Nouvelles stratégies de basculement pour le compte de base de données.
Paramètres d’options.
Retours
beginOfflineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
Hors connexion de la région spécifiée pour le compte de base de données Azure Cosmos DB spécifié.
function beginOfflineRegion(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- regionParameterForOffline
- RegionForOnlineOffline
Région Cosmos DB hors connexion pour le compte de base de données.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOfflineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOfflineRegionOptionalParams)
Hors connexion de la région spécifiée pour le compte de base de données Azure Cosmos DB spécifié.
function beginOfflineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOffline: RegionForOnlineOffline, options?: DatabaseAccountsOfflineRegionOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- regionParameterForOffline
- RegionForOnlineOffline
Région Cosmos DB hors connexion pour le compte de base de données.
Paramètres d’options.
Retours
Promise<void>
beginOnlineRegion(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
En ligne la région spécifiée pour le compte de base de données Azure Cosmos DB spécifié.
function beginOnlineRegion(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- regionParameterForOnline
- RegionForOnlineOffline
Région Cosmos DB à mettre en ligne pour le compte de base de données.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginOnlineRegionAndWait(string, string, RegionForOnlineOffline, DatabaseAccountsOnlineRegionOptionalParams)
En ligne la région spécifiée pour le compte de base de données Azure Cosmos DB spécifié.
function beginOnlineRegionAndWait(resourceGroupName: string, accountName: string, regionParameterForOnline: RegionForOnlineOffline, options?: DatabaseAccountsOnlineRegionOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- regionParameterForOnline
- RegionForOnlineOffline
Région Cosmos DB à mettre en ligne pour le compte de base de données.
Paramètres d’options.
Retours
Promise<void>
beginRegenerateKey(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
Régénère une clé d’accès pour le compte de base de données Azure Cosmos DB spécifié.
function beginRegenerateKey(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
Nom de la clé à régénérer.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRegenerateKeyAndWait(string, string, DatabaseAccountRegenerateKeyParameters, DatabaseAccountsRegenerateKeyOptionalParams)
Régénère une clé d’accès pour le compte de base de données Azure Cosmos DB spécifié.
function beginRegenerateKeyAndWait(resourceGroupName: string, accountName: string, keyToRegenerate: DatabaseAccountRegenerateKeyParameters, options?: DatabaseAccountsRegenerateKeyOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- keyToRegenerate
- DatabaseAccountRegenerateKeyParameters
Nom de la clé à régénérer.
Paramètres d’options.
Retours
Promise<void>
beginUpdate(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
Met à jour les propriétés d’un compte de base de données Azure Cosmos DB existant.
function beginUpdate(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- updateParameters
- DatabaseAccountUpdateParameters
Paramètres à fournir pour le compte de base de données actuel.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabaseAccountGetResults>, DatabaseAccountGetResults>>
beginUpdateAndWait(string, string, DatabaseAccountUpdateParameters, DatabaseAccountsUpdateOptionalParams)
Met à jour les propriétés d’un compte de base de données Azure Cosmos DB existant.
function beginUpdateAndWait(resourceGroupName: string, accountName: string, updateParameters: DatabaseAccountUpdateParameters, options?: DatabaseAccountsUpdateOptionalParams): Promise<DatabaseAccountGetResults>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- updateParameters
- DatabaseAccountUpdateParameters
Paramètres à fournir pour le compte de base de données actuel.
Paramètres d’options.
Retours
Promise<DatabaseAccountGetResults>
checkNameExists(string, DatabaseAccountsCheckNameExistsOptionalParams)
Vérifie que le nom du compte Azure Cosmos DB existe déjà. Un nom de compte valide peut contenir uniquement des lettres minuscules, des chiffres et le caractère « - », et doit être compris entre 3 et 50 caractères.
function checkNameExists(accountName: string, options?: DatabaseAccountsCheckNameExistsOptionalParams): Promise<DatabaseAccountsCheckNameExistsResponse>Paramètres
- accountName
-
string
Nom du compte de base de données Cosmos DB.
Paramètres d’options.
Retours
get(string, string, DatabaseAccountsGetOptionalParams)
Récupère les propriétés d’un compte de base de données Azure Cosmos DB existant.
function get(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetOptionalParams): Promise<DatabaseAccountGetResults>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
Paramètres d’options.
Retours
Promise<DatabaseAccountGetResults>
getReadOnlyKeys(string, string, DatabaseAccountsGetReadOnlyKeysOptionalParams)
Répertorie les clés d’accès en lecture seule pour le compte de base de données Azure Cosmos DB spécifié.
function getReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsGetReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
Paramètres d’options.
Retours
list(DatabaseAccountsListOptionalParams)
Répertorie tous les comptes de base de données Azure Cosmos DB disponibles sous l’abonnement.
function list(options?: DatabaseAccountsListOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>Paramètres
Paramètres d’options.
Retours
listByResourceGroup(string, DatabaseAccountsListByResourceGroupOptionalParams)
Répertorie tous les comptes de base de données Azure Cosmos DB disponibles sous le groupe de ressources donné.
function listByResourceGroup(resourceGroupName: string, options?: DatabaseAccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DatabaseAccountGetResults, DatabaseAccountGetResults[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
Paramètres d’options.
Retours
listConnectionStrings(string, string, DatabaseAccountsListConnectionStringsOptionalParams)
Répertorie les chaînes de connexion pour le compte de base de données Azure Cosmos DB spécifié.
function listConnectionStrings(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListConnectionStringsOptionalParams): Promise<DatabaseAccountListConnectionStringsResult>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
Paramètres d’options.
Retours
listKeys(string, string, DatabaseAccountsListKeysOptionalParams)
Répertorie les clés d’accès pour le compte de base de données Azure Cosmos DB spécifié.
function listKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListKeysOptionalParams): Promise<DatabaseAccountListKeysResult>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
Paramètres d’options.
Retours
Promise<DatabaseAccountListKeysResult>
listMetricDefinitions(string, string, DatabaseAccountsListMetricDefinitionsOptionalParams)
Récupère les définitions de métriques pour le compte de base de données donné.
function listMetricDefinitions(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
Paramètres d’options.
Retours
listMetrics(string, string, string, DatabaseAccountsListMetricsOptionalParams)
Récupère les métriques déterminées par le filtre donné pour le compte de base de données donné.
function listMetrics(resourceGroupName: string, accountName: string, filter: string, options?: DatabaseAccountsListMetricsOptionalParams): PagedAsyncIterableIterator<Metric, Metric[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
- filter
-
string
Expression de filtre OData qui décrit un sous-ensemble de métriques à retourner. Les paramètres qui peuvent être filtrés sont name.value (nom de la métrique, peuvent avoir un ou plusieurs noms), startTime, endTime et timeGrain. L’opérateur pris en charge est eq.
Paramètres d’options.
Retours
listReadOnlyKeys(string, string, DatabaseAccountsListReadOnlyKeysOptionalParams)
Répertorie les clés d’accès en lecture seule pour le compte de base de données Azure Cosmos DB spécifié.
function listReadOnlyKeys(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListReadOnlyKeysOptionalParams): Promise<DatabaseAccountListReadOnlyKeysResult>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
Paramètres d’options.
Retours
listUsages(string, string, DatabaseAccountsListUsagesOptionalParams)
Récupère les utilisations (données les plus récentes) pour le compte de base de données donné.
function listUsages(resourceGroupName: string, accountName: string, options?: DatabaseAccountsListUsagesOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de base de données Cosmos DB.
Paramètres d’options.