create_cosmosdb_account {AzureCosmosR} | R Documentation |
Create Azure Cosmos DB account
Description
Method for the AzureRMR::az_resource_group class.
Usage
create_cosmosdb_account( name, location = self$location, interface = c("sql", "cassandra", "mongo", "table", "graph"), serverless = FALSE, free_tier = FALSE, properties = list(), ... )
Arguments
-
name
: The name of the Cosmos DB account. -
location
: The location/region in which to create the account. Defaults to the resource group's location. -
interface
: The default API by which to access data in the account. -
serverless
: Whether this account should use provisioned throughput or a serverless mode. In the latter, you are charged solely on the basis of the traffic generated by your database operations. Serverless mode is best suited for small-to-medium workloads with light and intermittent traffic that is hard to forecast; it is currently (January 2021) in preview. -
free_tier
: Whether this account should be in the free tier, in which a certain amount of database operations are provided free of charge. You can have one free tier account per subscription. -
properties
: Additional properties to set for the account. -
wait
: Whether to wait until the Cosmos DB account provisioning is complete. -
...
: Optional arguments to pass toaz_cosmosdb$new()
.
Details
This method creates a new Azure Cosmos DB account in the given resource group. Azure Cosmos DB is a globally distributed multi-model database that supports the document, graph, and key-value data models.
The ARM resource object provides methods for working in the management plane. For working in the data plane, AzureCosmosR provides a client framework that interfaces with the core (SQL) API. Other packages provide functionality for other APIs, such as AzureTableStor for table storage and mongolite for MongoDB.
Value
An object of class az_cosmosdb
representing the Cosmos DB account.
See Also
get_cosmosdb_account, delete_cosmosdb_account
For the SQL API client framework: cosmos_endpoint, cosmos_database, cosmos_container, query_documents
For the table storage API: AzureTableStor::table_endpoint
For the MongoDB API: cosmos_mongo_endpoint, mongolite::mongo