共用方式為

az sql db ltr-backup

管理 SQL Database 長期保留備份。

命令

名稱 Description 類型 狀態
az sql db ltr-backup delete

刪除長期保留備份。

 Core GA
az sql db ltr-backup list

列出位置、伺服器或資料庫的長期保留備份。

 Core GA
az sql db ltr-backup lock-time-based-immutability

將基於時間的不變性鎖定在長期保留備份上，以防止刪除。

 Core GA
az sql db ltr-backup remove-legal-hold-immutability

移除長期保留備份資料庫的法律保留。

 Core Preview
az sql db ltr-backup remove-time-based-immutability

停用長期保留備份上以時間為基礎的不變性。

 Core GA
az sql db ltr-backup restore

將長期保留備份還原至新的資料庫。

 Core GA
az sql db ltr-backup set-legal-hold-immutability

在長期保留備份資料庫上設定法律保留。

 Core Preview
az sql db ltr-backup show

取得資料庫的長期保留備份。

 Core GA
az sql db ltr-backup wait

將 CLI 置於等候狀態，直到符合資料庫的條件為止。

 Core GA

az sql db ltr-backup delete

編輯

刪除長期保留備份。

az sql db ltr-backup delete --database
                            --location
                            --name
                            --server
                            [--yes]

範例

刪除資料庫的長期保留備份。

az sql db ltr-backup delete -l southeastasia -s myserver -d mydb -n "3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000"

必要參數

--database -d

Azure SQL Database 的名稱。 如果指定 [連同伺服器名稱]，則會擷取此資料庫下的所有要求備份。

--location -l

所需備份的位置。

--name -n

LTR 備份的名稱。 使用 'az sql db ltr-backup show' 或 'az sql db ltr-backup list' 進行備份名稱。

--server -s

Azure SQL Server 的名稱。 如果指定，則會擷取此伺服器下的所有要求備份。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--yes -y

請勿提示確認。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az sql db ltr-backup list

編輯

列出位置、伺服器或資料庫的長期保留備份。

az sql db ltr-backup list --location
                          [--database]
                          [--database-state --state]
                          [--latest --only-latest-per-database]
                          [--resource-group]
                          [--server]

範例

列出資料庫的長期保留備份。

az sql db ltr-backup list -l southeastasia -s myserver -d mydb

列出伺服器的長期保留備份（僅列出屬於實時資料庫的最新 LTR 備份）。

az sql db ltr-backup list -l southeastasia -s myserver --database-state Live --only-latest-per-database True

列出伺服器的長期保留備份（含資源群組自變數）。

az sql db ltr-backup list -l southeastasia -g mygroup -s myserver

列出位置的長期保留備份（僅列出屬於實時資料庫的最新 LTR 備份）。

az sql db ltr-backup list -l southeastasia --database-state Live --only-latest-per-database True

列出位置的長期保留備份（含資源群組自變數）。

az sql db ltr-backup list -l southeastasia -g mygroup

必要參數

--location -l

所需備份的位置。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--database -d

Azure SQL Database 的名稱。 如果指定 [連同伺服器名稱]，則會擷取此資料庫下的所有要求備份。

--database-state --state

'All'、'Live'或 'Deleted'。 只會從指定狀態的資料庫擷取備份。 如果未提供任何狀態，則預設為 『All』。

--latest --only-latest-per-database

如果為 true，則只會傳回每個資料庫的最新備份。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--server -s

Azure SQL Server 的名稱。 如果指定，則會擷取此伺服器下的所有要求備份。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az sql db ltr-backup lock-time-based-immutability

編輯

將基於時間的不變性鎖定在長期保留備份上，以防止刪除。

az sql db ltr-backup lock-time-based-immutability --database
                                                  --location
                                                  --name
                                                  --server
                                                  [--resource-group]
                                                  [--yes]

範例

鎖定資料庫的長期保留備份。

az sql db ltr-backup lock-time-based-immutability -g mygroup -l southeastasia -s myserver -d mydb -n "3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000"

必要參數

--database -d

Azure SQL Database 的名稱。 如果指定 [連同伺服器名稱]，則會擷取此資料庫下的所有要求備份。

--location -l

所需備份的位置。

--name -n

LTR 備份的名稱。 使用 'az sql db ltr-backup show' 或 'az sql db ltr-backup list' 進行備份名稱。

--server -s

Azure SQL Server 的名稱。 如果指定，則會擷取此伺服器下的所有要求備份。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--yes -y

請勿提示確認。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False
編輯
預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

移除長期保留備份資料庫的法律保留。

az sql db ltr-backup remove-legal-hold-immutability --database
                                                    --location
                                                    --name
                                                    --server
                                                    [--resource-group]
                                                    [--yes]

移除資料庫長期保留備份的合法保留。

az sql db ltr-backup remove-legal-hold-immutability -g mygroup -l southeastasia -s myserver -d mydb -n "3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000"
--database -d

Azure SQL Database 的名稱。 如果指定 [連同伺服器名稱]，則會擷取此資料庫下的所有要求備份。

--location -l

所需備份的位置。

--name -n

LTR 備份的名稱。 使用 'az sql db ltr-backup show' 或 'az sql db ltr-backup list' 進行備份名稱。

--server -s

Azure SQL Server 的名稱。 如果指定，則會擷取此伺服器下的所有要求備份。

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--yes -y

請勿提示確認。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az sql db ltr-backup remove-time-based-immutability

編輯

停用長期保留備份上以時間為基礎的不變性。

az sql db ltr-backup remove-time-based-immutability --database
                                                    --location
                                                    --name
                                                    --server
                                                    [--resource-group]
                                                    [--yes]

範例

停用資料庫長期保留備份上以時間為基礎的不變性。

az sql db ltr-backup remove-time-based-immutability -g mygroup -l southeastasia -s myserver -d mydb -n "3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000"

必要參數

--database -d

Azure SQL Database 的名稱。 如果指定 [連同伺服器名稱]，則會擷取此資料庫下的所有要求備份。

--location -l

所需備份的位置。

--name -n

LTR 備份的名稱。 使用 'az sql db ltr-backup show' 或 'az sql db ltr-backup list' 進行備份名稱。

--server -s

Azure SQL Server 的名稱。 如果指定，則會擷取此伺服器下的所有要求備份。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--yes -y

請勿提示確認。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az sql db ltr-backup restore

編輯

將長期保留備份還原至新的資料庫。

az sql db ltr-backup restore --backup-id
                             --dest-database
                             --dest-resource-group
                             --dest-server
                             [--assign-identity {false, true}]
                             [--auto-pause-delay]
                             [--availability-zone]
                             [--backup-storage-redundancy --bsr]
                             [--capacity]
                             [--compute-model {Provisioned, Serverless}]
                             [--edition --tier]
                             [--elastic-pool]
                             [--encryption-protector]
                             [--encryption-protector-auto-rotation --epauto {false, true}]
                             [--family]
                             [--federated-client-id]
                             [--ha-replicas --read-replicas]
                             [--keys]
                             [--license-type {BasePrice, LicenseIncluded}]
                             [--min-capacity]
                             [--no-wait]
                             [--preferred-enclave-type {Default, VBS}]
                             [--read-scale {Disabled, Enabled}]
                             [--service-level-objective --service-objective]
                             [--tags]
                             [--umi --user-assigned-identity-id]
                             [--zone-redundant {false, true}]

範例

還原 LTR 備份。

az sql db ltr-backup restore \
--dest-database targetdb --dest-server myserver --dest-resource-group mygroup \
--backup-id "/subscriptions/6caa113c-794c-42f8-ab9d-878d8aa104dc/resourceGroups/mygroup/providers/Microsoft.Sql/locations/southeastasia/longTermRetentionServers/myserver/longTermRetentionDatabases/sourcedb/longTermRetentionBackups/3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000"

必要參數

--backup-id

要還原之長期保留備份的資源標識符。 使用 'az sql db ltr-backup show' 或 'az sql db ltr-backup list' 進行備份標識符。

--dest-database

將建立為還原目的地的資料庫名稱。

--dest-resource-group

要還原資料庫之伺服器的資源群組名稱。

--dest-server

要還原資料庫的伺服器名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--assign-identity -i

指派資料庫的身分識別。

屬性 值
接受的值: false, true
--auto-pause-delay

在幾分鐘后自動暫停資料庫的時間。 -1 值表示已停用自動暫停。

屬性 值
參數群組: Serverless offering Arguments
--availability-zone

可用性區域。

--backup-storage-redundancy --bsr

用來儲存備份的備份記憶體備援。 允許的值包括：Local、Zone、Geo、GeoZone。

--capacity -c

SKU 的容量元件，以整數位 DTU 或虛擬核心為單位。

屬性 值
參數群組: Performance Level (components) Arguments
--compute-model

資料庫的計算模型。

屬性 值
參數群組: Serverless offering Arguments
接受的值: Provisioned, Serverless
--edition --tier -e

SKU 版本元件。 允許的值包括：Basic、Standard、Premium、GeneralPurpose、BusinessCritical、Hyperscale。

屬性 值
參數群組: Performance Level (components) Arguments
--elastic-pool

要用來建立資料庫之彈性集區的名稱或資源標識符。

屬性 值
參數群組: Performance Level Arguments
--encryption-protector

指定要作為資料庫加密保護裝置密鑰的 Azure 金鑰保存庫金鑰。

--encryption-protector-auto-rotation --epauto

指定資料庫加密保護裝置金鑰自動輪替旗標。 可以是 true、false 或 null。

屬性 值
接受的值: false, true
--family -f

SKU 的計算產生元件（僅適用於虛擬核心 SKU）。 允許的值包括：Gen4、Gen5。

屬性 值
參數群組: Performance Level (components) Arguments
--federated-client-id

SQL Database 的同盟用戶端標識碼。 它用於跨租使用者 CMK 案例。

--ha-replicas --read-replicas

要為資料庫布建的高可用性復本數目。 只有超大規模資料庫版本的可設定。

--keys

SQL Database 的 AKV 金鑰清單。

--license-type

要套用此資料庫的授權類型。如果您需要授權，或有授權且符合 Azure HybridBenefit 資格，請 LicenseIncludedBasePrice。

屬性 值
接受的值: BasePrice, LicenseIncluded
--min-capacity

如果尚未暫停，資料庫一律會配置的最小容量。

屬性 值
參數群組: Serverless offering Arguments
--no-wait

請勿等候長時間執行的作業完成。

屬性 值
預設值: False
--preferred-enclave-type

指定此資源的記憶體保護區類型。

屬性 值
接受的值: Default, VBS
--read-scale

如果啟用，將應用程式意圖設定為其連接字串中的唯讀連線，可能會路由傳送至唯讀次要複本。 此屬性僅適用於 Premium 和 Business Critical 資料庫。

屬性 值
接受的值: Disabled, Enabled
--service-level-objective --service-objective

新資料庫的服務目標。 例如：Basic、S0、P1、GP_Gen4_1、GP_S_Gen5_8、BC_Gen5_2、HS_Gen5_32。

屬性 值
參數群組: Performance Level Arguments
--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用 「清除現有的標記」。

--umi --user-assigned-identity-id

SQL Database 的使用者指派身分識別清單。

--zone-redundant -z

指定是否要啟用區域備援。 如果未指定任何值，預設值為 true。

屬性 值
接受的值: false, true
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False
編輯
預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

在長期保留備份資料庫上設定法律保留。

az sql db ltr-backup set-legal-hold-immutability --database
                                                 --location
                                                 --name
                                                 --server
                                                 [--resource-group]
                                                 [--yes]

在資料庫的長期保留備份上設定法定保留。

az sql db ltr-backup set-legal-hold-immutability -g mygroup -l southeastasia -s myserver -d mydb -n "3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000"
--database -d

Azure SQL Database 的名稱。 如果指定 [連同伺服器名稱]，則會擷取此資料庫下的所有要求備份。

--location -l

所需備份的位置。

--name -n

LTR 備份的名稱。 使用 'az sql db ltr-backup show' 或 'az sql db ltr-backup list' 進行備份名稱。

--server -s

Azure SQL Server 的名稱。 如果指定，則會擷取此伺服器下的所有要求備份。

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--yes -y

請勿提示確認。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az sql db ltr-backup show

編輯

取得資料庫的長期保留備份。

az sql db ltr-backup show --database
                          --location
                          --name
                          --server

範例

顯示資料庫的長期保留備份。

az sql db ltr-backup show -l southeastasia -s myserver -d mydb -n "3214b3fb-fba9-43e7-96a3-09e35ffcb336;132292152080000000;Hot"

必要參數

--database -d

Azure SQL Database 的名稱。 如果指定 [連同伺服器名稱]，則會擷取此資料庫下的所有要求備份。

--location -l

所需備份的位置。

--name -n

LTR 備份的名稱。 使用 'az sql db ltr-backup show' 或 'az sql db ltr-backup list' 進行備份名稱。

--server -s

Azure SQL Server 的名稱。 如果指定，則會擷取此伺服器下的所有要求備份。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az sql db ltr-backup wait

編輯

將 CLI 置於等候狀態，直到符合資料庫的條件為止。

az sql db ltr-backup wait [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--expand]
                          [--filter]
                          [--ids]
                          [--interval]
                          [--name]
                          [--resource-group]
                          [--server]
                          [--subscription]
                          [--timeout]
                          [--updated]

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

屬性 值
參數群組: Wait Condition Arguments
--deleted

等到刪除為止。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
--exists

等候資源存在。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
--expand

要包含在回應中的子資源。 預設值為 None。

--filter

篩選集合中元素的 OData 篩選表示式。 預設值為 None。

--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: Resource Id Arguments
--interval

輪詢間隔以秒為單位。

屬性 值
參數群組: Wait Condition Arguments
預設值: 30
--name -n

Azure SQL Database 的名稱。

屬性 值
參數群組: Resource Id Arguments
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

屬性 值
參數群組: Resource Id Arguments
--server -s

Azure SQL Server 的名稱。 您可以使用 來設定預設值 az configure --defaults sql-server=<name>。

屬性 值
參數群組: Resource Id Arguments
--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性 值
參數群組: Resource Id Arguments
--timeout

以秒為單位的等候上限。

屬性 值
參數群組: Wait Condition Arguments
預設值: 3600
--updated

等到 provisioningState 更新為 'Succeeded'。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False