Package com.azure.resourcemanager.cosmos.models

Interface CosmosDBAccount

All Superinterfaces:
GroupableResource<CosmosManager,DatabaseAccountGetResultsInner>, HasId, HasInnerModel<DatabaseAccountGetResultsInner>, HasManager<CosmosManager>, HasName, HasResourceGroup, Indexable, Refreshable<CosmosDBAccount>, Resource, SupportsUpdatingPrivateEndpointConnection, Updatable<CosmosDBAccount.Update>
public interface CosmosDBAccount extends GroupableResource<CosmosManager,DatabaseAccountGetResultsInner>, Refreshable<CosmosDBAccount>, Updatable<CosmosDBAccount.Update>, SupportsUpdatingPrivateEndpointConnection
An immutable client-side representation of an Azure Cosmos DB.

  • Method Details

    • kind

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

    • documentEndpoint

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

    • databaseAccountOfferType

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

    • publicNetworkAccess

      PublicNetworkAccess publicNetworkAccess()
      Whether the CosmosDB account can be accessed from public network.
      Returns:
      whether the CosmosDB account can be accessed from public network.

    • ipRangeFilter

      @Deprecated String ipRangeFilter()
      Deprecated.
      use ipRules()
      Gets specifies the set of IP addresses or IP address ranges in CIDR form.
      Returns:
      specifies the set of IP addresses or IP address ranges in CIDR form.

    • ipRules

      List<IpAddressOrRange> ipRules()
      Gets specifies the set of IP addresses or IP address ranges in CIDR form.
      Returns:
      specifies the set of IP addresses or IP address ranges in CIDR form.

    • consistencyPolicy

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

    • defaultConsistencyLevel

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

    • writableReplications

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

    • readableReplications

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

    • listKeys

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

    • listKeysAsync

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

    • listReadOnlyKeys

      DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys()
      Gets the read-only access keys for the specified Azure CosmosDB database account.
      Returns:
      the read-only access keys for the specified Azure CosmosDB database account

    • listReadOnlyKeysAsync

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

    • listConnectionStrings

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

    • listConnectionStringsAsync

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

    • listSqlDatabases

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

    • listSqlDatabasesAsync

      com.azure.core.http.rest.PagedFlux<SqlDatabase> listSqlDatabasesAsync()
      Gets the list of Azure Cosmos DB SQL databases.
      Returns:
      the list of Azure Cosmos DB SQL databases

    • multipleWriteLocationsEnabled

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

    • cassandraConnectorEnabled

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

    • cassandraConnectorOffer

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

    • keyBasedMetadataWriteAccessDisabled

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

    • listPrivateLinkResourcesAsync

      com.azure.core.http.rest.PagedFlux<PrivateLinkResource> listPrivateLinkResourcesAsync()
      Gets all private link resources in the account.
      Returns:
      all private link resources in the account.

    • listPrivateLinkResources

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

    • getPrivateLinkResourceAsync

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

    • getPrivateLinkResource

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

    • listPrivateEndpointConnectionAsync

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

    • listPrivateEndpointConnection

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

    • getPrivateEndpointConnectionAsync

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

    • getPrivateEndpointConnection

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

    • capabilities

      List<Capability> capabilities()
      Gets a list that contains the Cosmos DB capabilities.
      Returns:
      a list that contains the Cosmos DB capabilities

    • virtualNetworkRules

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

    • offlineRegion

      void offlineRegion(com.azure.core.management.Region region)
      It takes offline the specified region for the current Azure Cosmos DB database account.
      Parameters:
      region - Cosmos DB region

    • offlineRegionAsync

      Mono<Void> offlineRegionAsync(com.azure.core.management.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

      void onlineRegion(com.azure.core.management.Region region)
      It brings online the specified region for the current Azure Cosmos DB database account.
      Parameters:
      region - Cosmos DB region

    • onlineRegionAsync

      Mono<Void> onlineRegionAsync(com.azure.core.management.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)
      Regenerates secret keys.
      Parameters:
      keyKind - the key kind

    • regenerateKeyAsync

      Mono<Void> regenerateKeyAsync(KeyKind keyKind)
      A deferred emitter that regenerates secret keys.
      Parameters:
      keyKind - the key kind
      Returns:
      a representation of the deferred computation of this call

    • localAuthDisabled

      boolean localAuthDisabled()
      Checks whether local auth is disabled.
      Returns:
      whether local auth is disabled or not.

    • automaticFailoverEnabled

      default boolean automaticFailoverEnabled()
      Checks whether automatic failover is enabled. Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
      Returns:
      whether automatic failover is enabled