Package com.microsoft.azure.management.cosmosdb

Interface CosmosDBAccount

  • All Superinterfaces:
    com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource<com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager,​com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountInner>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasId, com.microsoft.azure.management.resources.fluentcore.model.HasInner<com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountInner>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager<com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasName, com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup, com.microsoft.azure.management.resources.fluentcore.model.Indexable, com.microsoft.azure.management.resources.fluentcore.model.Refreshable<CosmosDBAccount>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource, com.microsoft.azure.management.resources.fluentcore.model.Updatable<CosmosDBAccount.Update>
    @Beta(V1_2_0)
public interface CosmosDBAccount
extends com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource<com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager,​com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountInner>, com.microsoft.azure.management.resources.fluentcore.model.Refreshable<CosmosDBAccount>, com.microsoft.azure.management.resources.fluentcore.model.Updatable<CosmosDBAccount.Update>
    An immutable client-side representation of an Azure Cosmos DB.

    • Method Detail

      • documentEndpoint

        String documentEndpoint()
        Returns:
        the connection endpoint for the CosmosDB database account

      • databaseAccountOfferType

        DatabaseAccountOfferType databaseAccountOfferType()
        Returns:
        the offer type for the CosmosDB database account

      • ipRangeFilter

        String ipRangeFilter()
        Returns:
        specifies the set of IP addresses or IP address ranges in CIDR form.

      • consistencyPolicy

        ConsistencyPolicy consistencyPolicy()
        Returns:
        the consistency policy for the CosmosDB database account

      • defaultConsistencyLevel

        DefaultConsistencyLevel defaultConsistencyLevel()
        Returns:
        the default consistency level for the CosmosDB database account

      • writableReplications

        List<Location> writableReplications()
        Returns:
        an array that contains the writable georeplication locations enabled for the CosmosDB account

      • readableReplications

        List<Location> readableReplications()
        Returns:
        an array that contains the readable georeplication locations enabled for the CosmosDB account

      • listKeysAsync

        rx.Observable<DatabaseAccountListKeysResult> listKeysAsync()
        Returns:
        the access keys for the specified Azure CosmosDB database account

      • listReadOnlyKeysAsync

        rx.Observable<DatabaseAccountListReadOnlyKeysResult> listReadOnlyKeysAsync()
        Returns:
        the read-only access keys for the specified Azure CosmosDB database account

      • multipleWriteLocationsEnabled

        boolean multipleWriteLocationsEnabled()
        Returns:
        whether write is enabled for multiple locations or not

      • capabilities

        @Beta(V1_10_0)
List<Capability> capabilities()
        Returns:
        a list that contains the Cosmos DB capabilities

      • virtualNetworkRules

        @Beta(V1_10_0)
List<VirtualNetworkRule> virtualNetworkRules()
        Returns:
        a list that contains the Cosmos DB Virtual Network ACL Rules (empty list if none is set)

      • offlineRegion

        @Beta(V1_11_0)
void offlineRegion​(com.microsoft.azure.management.resources.fluentcore.arm.Region region)
        It takes offline the specified region for the current Azure Cosmos DB database account.
        Parameters:
        region - Cosmos DB region

      • offlineRegionAsync

        @Beta(V1_11_0)
rx.Completable offlineRegionAsync​(com.microsoft.azure.management.resources.fluentcore.arm.Region region)
        Asynchronously it takes offline the specified region for the current Azure Cosmos DB database account.
        Parameters:
        region - Cosmos DB region
        Returns:
        a representation of the deferred computation of this call

      • onlineRegion

        @Beta(V1_11_0)
void onlineRegion​(com.microsoft.azure.management.resources.fluentcore.arm.Region region)
        It brings online the specified region for the current Azure Cosmos DB database account.
        Parameters:
        region - Cosmos DB region

      • onlineRegionAsync

        @Beta(V1_11_0)
rx.Completable onlineRegionAsync​(com.microsoft.azure.management.resources.fluentcore.arm.Region region)
        Asynchronously it brings online the specified region for the current Azure Cosmos DB database account.
        Parameters:
        region - Cosmos DB region
        Returns:
        a representation of the deferred computation of this call

      • regenerateKey

        void regenerateKey​(KeyKind keyKind)
        Parameters:
        keyKind - the key kind

      • regenerateKeyAsync

        @Beta(V1_11_0)
rx.Completable regenerateKeyAsync​(KeyKind keyKind)
        Parameters:
        keyKind - the key kind
        Returns:
        a representation of the deferred computation of this call