az sql db-arc

Preview
Reference

Note

This reference is part of the arcdata extension for the Azure CLI (version 2.3.1 or higher). The extension will automatically install the first time you run an az sql db-arc command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage databases for Azure Arc-enabled SQL Server instance.

Commands

Name	Description	Type	Status
az sql db-arc backups-policy	Manage backups policy.	Extension	Preview
az sql db-arc backups-policy delete	Delete your current backups policy.	Extension	Preview
az sql db-arc backups-policy set	Set your backups policy.	Extension	Preview
az sql db-arc backups-policy show	See your current backups policy.	Extension	Preview
az sql db-arc restore	Restore a database from the built-in automatic backups.	Extension	Preview

az sql db-arc restore

Preview

Command group 'sql db-arc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Restore a database from the built-in automatic backups.

az sql db-arc restore --dest-name
                      --name
                      --resource-group
                      --server
                      [--time]

Examples

Ex 1 - Restoring a database

az sql db-arc restore --server myInstance --resource-group myResourceGroup --name mySourceDb --dest-name myNewDb --time "2021-10-20T05:34:22Z"

Required Parameters

--dest-name

Name of the database that will be created as the restore destination.

--name -n

Name of the source database from where the backups should be retrieved.

--resource-group -g

Name of the resource group where the Arc-enabled SQL Server instance is located.

--server -s

Name of the Arc-enabled SQL Server instance.

Optional Parameters

--time -t

The point in time of the source database that will be restored to create the new database. Must be more recent than or equal to the source database's earliest restore date/time value. Time should be in following format: YYYY-MM-DDTHH:MM:SSZ . The given time value must be in UTC. If no time is provided, the most recent backup will be restored. The given time value must be in UTC.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.