Package com.microsoft.azure.management.cosmosdb

Interface CosmosDBAccounts

  • All Superinterfaces:
    com.microsoft.azure.management.resources.fluentcore.model.HasInner<com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountsInner>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager<com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager>, com.microsoft.azure.management.resources.fluentcore.collection.SupportsBatchCreation<CosmosDBAccount>, com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating<CosmosDBAccount.DefinitionStages.Blank>, com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById, com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup, com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById<CosmosDBAccount>, com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup<CosmosDBAccount>, com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing<CosmosDBAccount>, com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup<CosmosDBAccount>
    @Beta(V1_2_0)
public interface CosmosDBAccounts
extends com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating<CosmosDBAccount.DefinitionStages.Blank>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager<com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager>, com.microsoft.azure.management.resources.fluentcore.model.HasInner<com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountsInner>, com.microsoft.azure.management.resources.fluentcore.collection.SupportsBatchCreation<CosmosDBAccount>, com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById<CosmosDBAccount>, com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById, com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup, com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing<CosmosDBAccount>, com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup<CosmosDBAccount>, com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup<CosmosDBAccount>
    Entry point to Cosmos DB management API.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void failoverPriorityChange​(String groupName, String accountName, List<Location> failoverPolicies)
      Changes the failover priority for the Azure CosmosDB database account.
      rx.Observable<Void> failoverPriorityChangeAsync​(String groupName, String accountName, List<Location> failoverPolicies)
      Changes the failover priority for the Azure CosmosDB database account.
      DatabaseAccountListConnectionStringsResult listConnectionStrings​(String groupName, String accountName)
      Lists the connection strings for the specified Azure CosmosDB database account.
      rx.Observable<DatabaseAccountListConnectionStringsResult> listConnectionStringsAsync​(String groupName, String accountName)
      Lists the connection strings for the specified Azure CosmosDB database account.
      DatabaseAccountListKeysResult listKeys​(String groupName, String accountName)
      Lists the access keys for the specified Azure CosmosDB database account.
      rx.Observable<DatabaseAccountListKeysResult> listKeysAsync​(String groupName, String accountName)
      Lists the access keys for the specified Azure CosmosDB database account.
      DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys​(String groupName, String accountName)
      Lists the read-only access keys for the specified Azure CosmosDB database account.
      rx.Observable<DatabaseAccountListReadOnlyKeysResult> listReadOnlyKeysAsync​(String groupName, String accountName)
      Lists the read-only access keys for the specified Azure CosmosDB database account.
      void regenerateKey​(String groupName, String accountName, KeyKind keyKind)
      Regenerates an access key for the specified Azure CosmosDB database account.
      rx.Observable<Void> regenerateKeyAsync​(String groupName, String accountName, KeyKind keyKind)
      Regenerates an access key for the specified Azure CosmosDB database account.

      • Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner

        inner

      • Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager

        manager

      • Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.collection.SupportsBatchCreation

        create, create, createAsync, createAsync, createAsync, createAsync

      • Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating

        define

      • Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById

        deleteById, deleteByIdAsync, deleteByIdAsync

      • Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup

        deleteByResourceGroup, deleteByResourceGroupAsync, deleteByResourceGroupAsync

      • Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById

        getById, getByIdAsync, getByIdAsync

      • Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup

        getByResourceGroup, getByResourceGroupAsync, getByResourceGroupAsync

      • Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing

        list, listAsync

      • Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup

        listByResourceGroup, listByResourceGroupAsync

    • Method Detail

      • failoverPriorityChange

        void failoverPriorityChange​(String groupName,
                            String accountName,
                            List<Location> failoverPolicies)
        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.
        Parameters:
        groupName - the group name
        accountName - the account name
        failoverPolicies - the list of failover policies

      • listKeys

        DatabaseAccountListKeysResult listKeys​(String groupName,
                                       String accountName)
        Lists the access keys for the specified Azure CosmosDB database account.
        Parameters:
        groupName - the group name
        accountName - the account name
        Returns:
        a list of keys

      • listReadOnlyKeys

        DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys​(String groupName,
                                                       String accountName)
        Lists the read-only access keys for the specified Azure CosmosDB database account.
        Parameters:
        groupName - the group name
        accountName - the account name
        Returns:
        a list of keys

      • listConnectionStrings

        DatabaseAccountListConnectionStringsResult listConnectionStrings​(String groupName,
                                                                 String accountName)
        Lists the connection strings for the specified Azure CosmosDB database account.
        Parameters:
        groupName - the group name
        accountName - the account name
        Returns:
        a list of connection strings

      • regenerateKey

        void regenerateKey​(String groupName,
                   String accountName,
                   KeyKind keyKind)
        Regenerates an access key for the specified Azure CosmosDB database account.
        Parameters:
        groupName - the group name
        accountName - the account name
        keyKind - the key kind

      • failoverPriorityChangeAsync

        rx.Observable<Void> failoverPriorityChangeAsync​(String groupName,
                                                String accountName,
                                                List<Location> failoverPolicies)
        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.
        Parameters:
        groupName - the group name
        accountName - the account name
        failoverPolicies - the list of failover policies
        Returns:
        the ServiceResponse object if successful.

      • listKeysAsync

        rx.Observable<DatabaseAccountListKeysResult> listKeysAsync​(String groupName,
                                                           String accountName)
        Lists the access keys for the specified Azure CosmosDB database account.
        Parameters:
        groupName - the group name
        accountName - the account name
        Returns:
        a list of keys

      • listReadOnlyKeysAsync

        rx.Observable<DatabaseAccountListReadOnlyKeysResult> listReadOnlyKeysAsync​(String groupName,
                                                                           String accountName)
        Lists the read-only access keys for the specified Azure CosmosDB database account.
        Parameters:
        groupName - the group name
        accountName - the account name
        Returns:
        a list of keys

      • listConnectionStringsAsync

        rx.Observable<DatabaseAccountListConnectionStringsResult> listConnectionStringsAsync​(String groupName,
                                                                                     String accountName)
        Lists the connection strings for the specified Azure CosmosDB database account.
        Parameters:
        groupName - the group name
        accountName - the account name
        Returns:
        a list of connection strings

      • regenerateKeyAsync

        rx.Observable<Void> regenerateKeyAsync​(String groupName,
                                       String accountName,
                                       KeyKind keyKind)
        Regenerates an access key for the specified Azure CosmosDB database account.
        Parameters:
        groupName - the group name
        accountName - the account name
        keyKind - the key kind
        Returns:
        the ServiceResponse object if successful.