CosmosDBAccount (Microsoft Azure Management Libraries for Java 1.41.2)

All Superinterfaces:

com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource<com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager,com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountGetResultsInner>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasId, com.microsoft.azure.management.resources.fluentcore.model.HasInner<com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountGetResultsInner>, 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(value=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.DatabaseAccountGetResultsInner>, 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.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`CosmosDBAccount.Definition` Grouping of cosmos db definition stages.
`static interface`	`CosmosDBAccount.DefinitionStages` Grouping of cosmos db definition stages.
`static interface`	`CosmosDBAccount.Update` Grouping of cosmos db update stages.
`static interface`	`CosmosDBAccount.UpdateStages` Grouping of cosmos db update stages.

Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource
com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<Capability>`	`capabilities()`
`boolean`	`cassandraConnectorEnabled()`
`ConnectorOffer`	`cassandraConnectorOffer()`
`ConsistencyPolicy`	`consistencyPolicy()`
`DatabaseAccountOfferType`	`databaseAccountOfferType()`
`DefaultConsistencyLevel`	`defaultConsistencyLevel()`
`String`	`documentEndpoint()`
`PrivateEndpointConnection`	`getPrivateEndpointConnection(String name)`
`rx.Observable<PrivateEndpointConnection>`	`getPrivateEndpointConnectionAsync(String name)`
`PrivateLinkResource`	`getPrivateLinkResource(String groupName)`
`rx.Observable<PrivateLinkResource>`	`getPrivateLinkResourceAsync(String groupName)`
`String`	`ipRangeFilter()`
`boolean`	`keyBasedMetadataWriteAccessDisabled()`
`DatabaseAccountKind`	`kind()`
`DatabaseAccountListConnectionStringsResult`	`listConnectionStrings()`
`rx.Observable<DatabaseAccountListConnectionStringsResult>`	`listConnectionStringsAsync()`
`DatabaseAccountListKeysResult`	`listKeys()`
`rx.Observable<DatabaseAccountListKeysResult>`	`listKeysAsync()`
`Map<String,PrivateEndpointConnection>`	`listPrivateEndpointConnection()`
`rx.Observable<Map<String,PrivateEndpointConnection>>`	`listPrivateEndpointConnectionAsync()`
`List<PrivateLinkResource>`	`listPrivateLinkResources()`
`rx.Observable<List<PrivateLinkResource>>`	`listPrivateLinkResourcesAsync()`
`DatabaseAccountListReadOnlyKeysResult`	`listReadOnlyKeys()`
`rx.Observable<DatabaseAccountListReadOnlyKeysResult>`	`listReadOnlyKeysAsync()`
`List<SqlDatabase>`	`listSqlDatabases()`
`rx.Observable<List<SqlDatabase>>`	`listSqlDatabasesAsync()`
`boolean`	`multipleWriteLocationsEnabled()`
`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.
`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.
`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.
`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.
`List<Location>`	`readableReplications()`
`void`	`regenerateKey(KeyKind keyKind)`
`rx.Completable`	`regenerateKeyAsync(KeyKind keyKind)`
`List<VirtualNetworkRule>`	`virtualNetworkRules()`
`List<Location>`	`writableReplications()`

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource
region, regionName, tags, type

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable
key

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasId
id

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasName
name

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup
resourceGroupName

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

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

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable
refresh, refreshAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Updatable
update

- Method Detail
  - 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(value=V1_10_0)
List<Capability> capabilities()
```
    Returns:
    
    a list that contains the Cosmos DB capabilities
  - virtualNetworkRules
```
@Beta(value=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(value=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(value=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(value=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(value=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(value=V1_11_0)
rx.Completable regenerateKeyAsync(KeyKind keyKind)
```
    Parameters:
    
    keyKind - the key kind
    
    Returns:
    
    a representation of the deferred computation of this call

/** 
* Copyright (c) Microsoft Corporation. All rights reserved. 
* Licensed under the MIT License. See License.txt in the project root for 
* license information. 
*/

Interface CosmosDBAccount

Nested Class Summary

Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

Method Summary

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

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

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

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

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

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

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

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

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

Method Detail

kind

documentEndpoint

databaseAccountOfferType

ipRangeFilter

consistencyPolicy

defaultConsistencyLevel

writableReplications

readableReplications

listKeys

listKeysAsync

listReadOnlyKeys

listReadOnlyKeysAsync

listConnectionStrings

listConnectionStringsAsync

listSqlDatabases

listSqlDatabasesAsync

multipleWriteLocationsEnabled

cassandraConnectorEnabled

cassandraConnectorOffer

keyBasedMetadataWriteAccessDisabled

listPrivateLinkResourcesAsync

listPrivateLinkResources

getPrivateLinkResourceAsync

getPrivateLinkResource

listPrivateEndpointConnectionAsync

listPrivateEndpointConnection

getPrivateEndpointConnectionAsync

getPrivateEndpointConnection

capabilities

virtualNetworkRules

offlineRegion

offlineRegionAsync

onlineRegion

onlineRegionAsync

regenerateKey

regenerateKeyAsync