com.microsoft.azure.management.cosmosdb

Interface CosmosDBAccount

All Superinterfaces:

GroupableResource<com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager,com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountInner>, HasId, HasInner<com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountInner>, HasManager<com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager>, HasName, HasResourceGroup, Indexable, Refreshable<CosmosDBAccount>, Resource, Updatable<CosmosDBAccount.Update>

@Beta(value=V1_2_0)
public interface CosmosDBAccount
extends GroupableResource<com.microsoft.azure.management.cosmosdb.implementation.CosmosDBManager,com.microsoft.azure.management.cosmosdb.implementation.DatabaseAccountInner>, Refreshable<CosmosDBAccount>, 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

Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>

Method Summary

Modifier and Type	Method and Description
List<Capability>	capabilities()
ConsistencyPolicy	consistencyPolicy()
DatabaseAccountOfferType	databaseAccountOfferType()
DefaultConsistencyLevel	defaultConsistencyLevel()
String	documentEndpoint()
String	ipRangeFilter()
DatabaseAccountKind	kind()
DatabaseAccountListConnectionStringsResult	listConnectionStrings()
rx.Observable<DatabaseAccountListConnectionStringsResult>	listConnectionStringsAsync()
DatabaseAccountListKeysResult	listKeys()
rx.Observable<DatabaseAccountListKeysResult>	listKeysAsync()
DatabaseAccountListReadOnlyKeysResult	listReadOnlyKeys()
rx.Observable<DatabaseAccountListReadOnlyKeysResult>	listReadOnlyKeysAsync()
boolean	multipleWriteLocationsEnabled()
void	offlineRegion(Region region) It takes offline the specified region for the current Azure Cosmos DB database account.
rx.Completable	offlineRegionAsync(Region region) Asynchronously it takes offline the specified region for the current Azure Cosmos DB database account.
void	onlineRegion(Region region) It brings online the specified region for the current Azure Cosmos DB database account.
rx.Completable	onlineRegionAsync(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

multipleWriteLocationsEnabled

boolean multipleWriteLocationsEnabled()

Returns:

whether write is enabled for multiple locations or not

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