Package com.microsoft.azure.management.cosmosdb

Interface CosmosDBAccount

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

  • Method Details

    • kind

      DatabaseAccountKind kind()
      Returns:
      indicates the type of database account

    • 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

    • listKeys

      DatabaseAccountListKeysResult listKeys()
      Returns:
      the access keys for the specified Azure CosmosDB database account

    • listKeysAsync

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

    • listReadOnlyKeys

      DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys()
      Returns:
      the read-only 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

    • listConnectionStrings

      DatabaseAccountListConnectionStringsResult listConnectionStrings()
      Returns:
      the connection strings for the specified Azure CosmosDB database account

    • listConnectionStringsAsync

      rx.Observable<DatabaseAccountListConnectionStringsResult> listConnectionStringsAsync()
      Returns:
      the connection strings for the specified Azure CosmosDB database account

    • listSqlDatabases

      List<SqlDatabase> listSqlDatabases()
      Returns:
      the list of Azure Cosmos DB SQL databases

    • listSqlDatabasesAsync

      rx.Observable<List<SqlDatabase>> listSqlDatabasesAsync()
      Returns:
      the list of Azure Cosmos DB SQL databases

    • multipleWriteLocationsEnabled

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

    • cassandraConnectorEnabled

      boolean cassandraConnectorEnabled()
      Returns:
      whether cassandra connector is enabled or not.

    • cassandraConnectorOffer

      ConnectorOffer cassandraConnectorOffer()
      Returns:
      the current cassandra connector offer.

    • keyBasedMetadataWriteAccessDisabled

      boolean keyBasedMetadataWriteAccessDisabled()
      Returns:
      whether metadata write access is disabled or not.

    • listPrivateLinkResourcesAsync

      rx.Observable<List<PrivateLinkResource>> listPrivateLinkResourcesAsync()
      Returns:
      all private link resources in the account.

    • listPrivateLinkResources

      List<PrivateLinkResource> listPrivateLinkResources()
      Returns:
      all private link resources in the account.

    • getPrivateLinkResourceAsync

      rx.Observable<PrivateLinkResource> getPrivateLinkResourceAsync(String groupName)
      Parameters:
      groupName - group name of private link resource
      Returns:
      the specific private link resource group

    • getPrivateLinkResource

      PrivateLinkResource getPrivateLinkResource(String groupName)
      Parameters:
      groupName - group name of private link resource
      Returns:
      the specific private link resource group

    • listPrivateEndpointConnectionAsync

      rx.Observable<Map<String,PrivateEndpointConnection>> listPrivateEndpointConnectionAsync()
      Returns:
      all private endpoint connection in the account.

    • listPrivateEndpointConnection

      Map<String,PrivateEndpointConnection> listPrivateEndpointConnection()
      Returns:
      all private endpoint connection in the account.

    • getPrivateEndpointConnectionAsync

      rx.Observable<PrivateEndpointConnection> getPrivateEndpointConnectionAsync(String name)
      Parameters:
      name - name of private endpoint connection
      Returns:
      the specific private endpoint connection

    • getPrivateEndpointConnection

      PrivateEndpointConnection getPrivateEndpointConnection(String name)
      Parameters:
      name - name of private endpoint connection
      Returns:
      the specific private endpoint connection

    • 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(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(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(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(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