az spring app binding cosmos
Note
This reference is part of the spring extension for the Azure CLI (version 2.56.0 or higher). The extension will automatically install the first time you run an az spring app binding cosmos command. Learn more about extensions.
This command group is implicitly deprecated because command group 'spring app binding' is deprecated and will be removed in a future release. Use 'spring connection' instead.
Commands to manage Azure Cosmos DB bindings.
Commands
Name | Description | Type | Status |
---|---|---|---|
az spring app binding cosmos add |
Bind an Azure Cosmos DB with the app. |
Extension | Deprecated |
az spring app binding cosmos update |
Update an Azure Cosmos DB service binding of the app. |
Extension | Deprecated |
az spring app binding cosmos add
This command is implicitly deprecated because command group 'spring app binding' is deprecated and will be removed in a future release. Use 'spring connection' instead.
Bind an Azure Cosmos DB with the app.
az spring app binding cosmos add --api-type {cassandra, gremlin, mongo, sql, table}
--app
--name
--resource-group
--resource-id
--service
[--collection-name]
[--database-name]
[--key-space]
Examples
Bind an Azure Cosmos DB.
az spring app binding cosmos add -n cosmosProduction --app MyApp --resource-id COSMOSDB_ID --api-type mongo --database mymongo -g MyResourceGroup -s MyService
Required Parameters
Type of API.
Name of app.
Name of service binding.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Azure resource ID of the service to bind with.
The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.
Optional Parameters
Name of collection. Required for gremlin.
Name of database. Required for mongo, sql, gremlin.
Cassandra key space. Required for cassandra.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az spring app binding cosmos update
This command is implicitly deprecated because command group 'spring app binding' is deprecated and will be removed in a future release. Use 'spring connection' instead.
Update an Azure Cosmos DB service binding of the app.
az spring app binding cosmos update --app
--name
--resource-group
--service
[--collection-name]
[--database-name]
[--key-space]
Required Parameters
Name of app.
Name of service binding.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of Azure Spring Apps instance, you can configure the default service using az configure --defaults spring=.
Optional Parameters
Name of collection. Required for gremlin.
Name of database. Required for mongo, sql, gremlin.
Cassandra key space. Required for cassandra.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.