Skip to content

cosmos-db-database

Manage Cosmos DB databases (mirrored from Azure Cosmos DB)

Authentication scope: fabric

List Cosmos DB databases in a workspace

Terminal window
fabio cosmos-db-database list --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID

Read-only · Returns list

Show details of a Cosmos DB database

Terminal window
fabio cosmos-db-database show --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Cosmos DB database ID

Read-only · Returns object

Create a new Cosmos DB database

Terminal window
fabio cosmos-db-database create --workspace <value> --name <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--name string Yes Display name
--description string No Optional description
--sensitivity-label string No Sensitivity label ID to apply on creation

Examples

Terminal window
fabio cosmos-db-database create --workspace $WS --name "CosmosOrders"

Mutates state · Returns object

Update Cosmos DB database properties

Terminal window
fabio cosmos-db-database update --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Cosmos DB database ID
--name string No New display name
--description string No New description

Mutates state · Returns object

Delete a Cosmos DB database

Terminal window
fabio cosmos-db-database delete --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Cosmos DB database ID
--hard-delete bool No Permanently delete (cannot be recovered)

Mutates state · Destructive · Returns void

Get the definition of a Cosmos DB database

Terminal window
fabio cosmos-db-database get-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Cosmos DB database ID
--decode bool No Decode base64 payloads inline (adds decodedPayload field)

Read-only · Long-running operation · Returns object

Update the definition of a Cosmos DB database

Terminal window
fabio cosmos-db-database update-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Cosmos DB database ID
--file string No Path to definition file
--content string No Inline definition content

Mutates state · Long-running operation · Returns void