com.azure.resourcemanager.cosmos.models.CosmosDBAccounts Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-cosmos Show documentation
This package contains Microsoft Azure CosmosDB SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt
There is a newer version: 2.46.0
Show newest version
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.resourcemanager.cosmos.models;

import com.azure.core.annotation.Fluent;
import com.azure.resourcemanager.cosmos.CosmosManager;
import com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup;
import com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById;
import com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup;
import com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup;
import com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager;
import com.azure.resourcemanager.resources.fluentcore.collection.SupportsBatchCreation;
import com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating;
import com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById;
import com.azure.resourcemanager.resources.fluentcore.collection.SupportsListing;
import reactor.core.publisher.Mono;

import java.util.List;

/** Entry point to Cosmos DB management API. */
@Fluent
public interface CosmosDBAccounts
    extends SupportsCreating,
        HasManager,
        SupportsBatchCreation,
        SupportsGettingById,
        SupportsDeletingById,
        SupportsDeletingByResourceGroup,
        SupportsListing,
        SupportsListingByResourceGroup,
        SupportsGettingByResourceGroup {

    /**
     * Changes the failover priority for the Azure CosmosDB database account. A failover priority of 0 indicates a write
     * region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must
     * be unique for each of the regions in which the database account exists.
     *
     * @param groupName the group name
     * @param accountName the account name
     * @param failoverPolicies the list of failover policies
     */
    void failoverPriorityChange(String groupName, String accountName, List failoverPolicies);

    /**
     * Lists the access keys for the specified Azure CosmosDB database account.
     *
     * @param groupName the group name
     * @param accountName the account name
     * @return a list of keys
     */
    DatabaseAccountListKeysResult listKeys(String groupName, String accountName);

    /**
     * Lists the read-only access keys for the specified Azure CosmosDB database account.
     *
     * @param groupName the group name
     * @param accountName the account name
     * @return a list of keys
     */
    DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys(String groupName, String accountName);

    /**
     * Lists the connection strings for the specified Azure CosmosDB database account.
     *
     * @param groupName the group name
     * @param accountName the account name
     * @return a list of connection strings
     */
    DatabaseAccountListConnectionStringsResult listConnectionStrings(String groupName, String accountName);

    /**
     * Regenerates an access key for the specified Azure CosmosDB database account.
     *
     * @param groupName the group name
     * @param accountName the account name
     * @param keyKind the key kind
     */
    void regenerateKey(String groupName, String accountName, KeyKind keyKind);

    /**
     * Changes the failover priority for the Azure CosmosDB database account. A failover priority of 0 indicates a write
     * region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must
     * be unique for each of the regions in which the database account exists.
     *
     * @param groupName the group name
     * @param accountName the account name
     * @param failoverPolicies the list of failover policies
     * @return the ServiceResponse object if successful.
     */
    Mono failoverPriorityChangeAsync(String groupName, String accountName, List failoverPolicies);

    /**
     * Lists the access keys for the specified Azure CosmosDB database account.
     *
     * @param groupName the group name
     * @param accountName the account name
     * @return a list of keys
     */
    Mono listKeysAsync(String groupName, String accountName);

    /**
     * Lists the read-only access keys for the specified Azure CosmosDB database account.
     *
     * @param groupName the group name
     * @param accountName the account name
     * @return a list of keys
     */
    Mono listReadOnlyKeysAsync(String groupName, String accountName);

    /**
     * Lists the connection strings for the specified Azure CosmosDB database account.
     *
     * @param groupName the group name
     * @param accountName the account name
     * @return a list of connection strings
     */
    Mono listConnectionStringsAsync(String groupName, String accountName);

    /**
     * Regenerates an access key for the specified Azure CosmosDB database account.
     *
     * @param groupName the group name
     * @param accountName the account name
     * @param keyKind the key kind
     * @return the ServiceResponse object if successful.
     */
    Mono regenerateKeyAsync(String groupName, String accountName, KeyKind keyKind);
}