az cosmosdb sql database

Note

這個指令群組的指令在 Azure CLI 和至少一個擴充功能中都有定義。 安裝每個擴充功能以受益於其擴充功能。 深入了解擴充功能。

Manage Azure Cosmos DB SQL databases.

命令

名稱 Description 類型 狀態
az cosmosdb sql database create

喺 Azure Cosmos DB 帳戶下建立 SQL 資料庫。

Core GA
az cosmosdb sql database delete

刪除 Azure Cosmos DB 帳戶下嘅 SQL 資料庫。

Core GA
az cosmosdb sql database exists

檢查是否有 Azure Cosmos DB SQL 資料庫存在。

Core GA
az cosmosdb sql database list

將 SQL 資料庫列入 Azure Cosmos DB 帳戶。

Core GA
az cosmosdb sql database merge

合併 sql Database 的數據分割。

Extension Preview
az cosmosdb sql database restore

還原相同帳戶內已刪除的 SQL 資料庫。

Core GA
az cosmosdb sql database restore (cosmosdb-preview 擴充功能)

還原相同帳戶內已刪除的 SQL 資料庫。

Extension Preview
az cosmosdb sql database show

顯示 Azure Cosmos DB 帳戶下 SQL 資料庫的詳細資料。

Core GA
az cosmosdb sql database throughput

管理 Azure Cosmos DB 帳戶下 SQL 資料庫的吞吐量。

Core GA
az cosmosdb sql database throughput migrate

在自動調整和手動布建之間移轉 SQL 資料庫的輸送量。

Core GA
az cosmosdb sql database throughput show

取得 Azure Cosmos DB 帳戶下 SQL 資料庫的吞吐量。

Core GA
az cosmosdb sql database throughput update

更新 Azure Cosmos DB 帳號下的 SQL 資料庫吞吐量。

Core GA

az cosmosdb sql database create

喺 Azure Cosmos DB 帳戶下建立 SQL 資料庫。

az cosmosdb sql database create --account-name
                                --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--max-throughput]
                                [--throughput]

必要參數

--account-name -a

Cosmosdb 帳戶名稱。

--name -n

資料庫名稱。

--resource-group -g

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

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--max-throughput

輸送量資源上限可以調整為 (RU/秒)。 提供資源啟用自動調整時。 最小值可以是 4000 (RU/秒)。

--throughput

SQL 資料庫的輸送量(RU/秒)。 預設值為 400。

全域參數
--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 cosmosdb sql database delete

刪除 Azure Cosmos DB 帳戶下嘅 SQL 資料庫。

az cosmosdb sql database delete --account-name
                                --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--yes]

必要參數

--account-name -a

Cosmosdb 帳戶名稱。

--name -n

資料庫名稱。

--resource-group -g

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

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--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 cosmosdb sql database exists

檢查是否有 Azure Cosmos DB SQL 資料庫存在。

az cosmosdb sql database exists --account-name
                                --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]

必要參數

--account-name -a

Cosmosdb 帳戶名稱。

--name -n

資料庫名稱。

--resource-group -g

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

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
全域參數
--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 cosmosdb sql database list

將 SQL 資料庫列入 Azure Cosmos DB 帳戶。

az cosmosdb sql database list --account-name
                              --resource-group

範例

List the SQL databases in a Azure Cosmos DB account (autogenerated)

az cosmosdb sql database list --account-name MyAccount --resource-group MyResourceGroup

必要參數

--account-name -a

Cosmosdb 帳戶名稱。

--resource-group -g

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

全域參數
--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 cosmosdb sql database merge

預覽

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

合併 sql Database 的數據分割。

az cosmosdb sql database merge --account-name
                               --name
                               --resource-group
                               [--acquire-policy-token]
                               [--change-reference]

範例

合併資料庫 my-database 的數據分割

az cosmosdb sql database merge -g my-resource-group -a my-account --name my-database

必要參數

--account-name -a

CosmosDB 資料庫帳戶的名稱。

--name -n

CosmosDB 資料庫名稱的名稱。

--resource-group -g

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

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
全域參數
--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 cosmosdb sql database restore

還原相同帳戶內已刪除的 SQL 資料庫。

az cosmosdb sql database restore --account-name
                                 --name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--disable-ttl]
                                 [--restore-timestamp]

範例

還原相同帳戶內已刪除的 SQL 資料庫。

az cosmosdb sql database restore --resource-group resource_group --account-name database_account_name --name name_of_database_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

必要參數

--account-name -a

Cosmosdb 帳戶名稱。

--name -n

資料庫名稱。

--resource-group -g

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

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--disable-ttl

停用 TTL 還原的旗標。

使用方式:--disable-ttl True 預設值:false。

--restore-timestamp -t

資料庫必須還原至的時間戳。

全域參數
--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 cosmosdb sql database restore (cosmosdb-preview 擴充功能)

預覽

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

還原相同帳戶內已刪除的 SQL 資料庫。

az cosmosdb sql database restore --account-name
                                 --name
                                 --resource-group
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--disable-ttl {false, true}]
                                 [--restore-timestamp]

範例

還原相同帳戶內已刪除的 SQL 資料庫。

az cosmosdb sql database restore --resource-group resource_group --account-name database_account_name --name name_of_database_needs_to_be_restored --restore-timestamp 2020-07-13T16:03:41+0000

必要參數

--account-name -a

Cosmosdb 帳戶名稱。

--name -n

資料庫名稱。

--resource-group -g

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

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性
參數群組: Global Policy Arguments
--disable-ttl
預覽

啟用或停用已停用ttl還原。

屬性
接受的值: false, true
--restore-timestamp -t

資料庫必須還原至的時間戳。

全域參數
--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 cosmosdb sql database show

顯示 Azure Cosmos DB 帳戶下 SQL 資料庫的詳細資料。

az cosmosdb sql database show --account-name
                              --name
                              --resource-group

必要參數

--account-name -a

Cosmosdb 帳戶名稱。

--name -n

資料庫名稱。

--resource-group -g

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

全域參數
--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