az cosmosdb copy

  • 預覽

Note

此參考文獻是Azure CLI版本 cosmosdb-preview 擴充套件（版本 2.17.1 或更高版本）的一部分。 擴充功能會在您第一次執行 az cosmosdb copy 命令時自動安裝。 深入了解擴充功能。

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

管理容器複製作業。

命令

名稱 Description 類型 狀態
az cosmosdb copy cancel

取消容器複製作業。

 Extension Preview
az cosmosdb copy complete

完成在線容器複製作業。

 Extension Preview
az cosmosdb copy create

建立容器複製作業。

 Extension Preview
az cosmosdb copy list

取得容器複製作業。

 Extension Preview
az cosmosdb copy pause

暫停容器複製作業。

 Extension Preview
az cosmosdb copy resume

繼續容器複製作業。

 Extension Preview
az cosmosdb copy show

取得容器複製作業。

 Extension Preview

az cosmosdb copy cancel

預覽

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

取消容器複製作業。

az cosmosdb copy cancel --account-name
                        --job-name
                        --resource-group
                        [--acquire-policy-token]
                        [--change-reference]

範例

取消作業 j1

az cosmosdb copy cancel -g "rg1" --account-name "acc1" --job-name "j1"

必要參數

--account-name -a

Azure Cosmos DB 帳號名稱，工作建立的地點。 從 create job 命令使用 --dest-account 值。

--job-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 copy complete

預覽

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

完成在線容器複製作業。

az cosmosdb copy complete --account-name
                          --job-name
                          --resource-group
                          [--acquire-policy-token]
                          [--change-reference]

範例

完成作業 j1

az cosmosdb copy complete -g "rg1" --account-name "acc1" --job-name "j1"

必要參數

--account-name -a

Azure Cosmos DB 帳號名稱，工作建立的地點。 從 create job 命令使用 --dest-account 值。

--job-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 copy create

預覽

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

建立容器複製作業。

az cosmosdb copy create --resource-group
                        --src-account
                        [--acquire-policy-token]
                        [--change-reference]
                        [--dest-account]
                        [--dest-cassandra]
                        [--dest-mongo]
                        [--dest-mongo-vcore]
                        [--dest-nosql]
                        [--job-name]
                        [--mode]
                        [--src-cassandra]
                        [--src-mongo]
                        [--src-nosql]

範例

Copy Azure Cosmos DB API for NoSQL container in same account

az cosmosdb copy create -g "rg1" --job-name "j1" --src-account "acc1" --dest-account "acc1" --src-nosql database=db1 container=c1 --dest-nosql database=db2 container=c2

Copy Azure Cosmos DB API for NoSQL container in different account

az cosmosdb copy create -g "rg1" --job-name "j1" --src-account "acc1" --dest-account "acc2" --src-nosql database=db1 container=c1 --dest-nosql database=db2 container=c2

Copy Azure Cosmos DB API for Apache Cassandra table

az cosmosdb copy create -g "rg1" --job-name "j1" --src-account "acc1" --dest-account "acc1" --src-cassandra keyspace=k1 table=t1 --dest-cassandra keyspace=k2 table=t2

Copy Azure Cosmos DB API for MongoDB collection

az cosmosdb copy create -g "rg1" --job-name "j1" --src-account "acc1" --dest-account "acc1" --src-mongo database=d1 collection=c1 --dest-mongo database=d2 collection=c2

Copy Azure Cosmos DB API from MongoDB（RU） collection to Mongo（vCore） collection

az cosmosdb copy create -g "rg1" --job-name "j1" --src-account "acc1" --src-mongo database=d1 collection=c1 --dest-mongo-vcore database=d2 collection=c2 connectionStringKeyVaultUri=<link_to_Azure_KeyVault_secret>

必要參數

--resource-group -g

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

--src-account

Azure Cosmos DB source database account嘅名稱。

選擇性參數

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

--acquire-policy-token

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

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

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

屬性 值
參數群組: Global Policy Arguments
--dest-account

Azure Cosmos DB destination database account嘅名稱。

--dest-cassandra

目的地數據表。

使用方式：-dest-cassandra keyspace=XX table=XX' keyspace：Keyspace 名稱。 table：數據表名稱。

屬性 值
參數群組: Azure Cosmos DB API for Apache Cassandra table copy Arguments
--dest-mongo

目的地集合。

使用量：--dest-mongo 資料庫=XX 集合=XX' 資料庫：資料庫名稱。 集合：集合名稱。

屬性 值
參數群組: Azure Cosmos DB API for MongoDB (RU) collection copy Arguments
--dest-mongo-vcore

目的地 Mongo（虛擬核心） 集合。

使用量：--dest-mongo-vcore 資料庫=XX 集合=XX connectionStringKeyVaultUri=XX' 資料庫：資料庫名稱。 集合：集合名稱。 connectionStringKeyVaultUri：連結至 Azure KeyVault 秘密，包含 連接字串。

屬性 值
參數群組: Azure Cosmos DB API for MongoDB (vCore) collection copy Arguments
--dest-nosql

目的地容器。

使用方式：-dest-nosql database=XX container=XX' 資料庫：資料庫名稱。 容器：容器名稱。

屬性 值
參數群組: Azure Cosmos DB API for NoSQL container copy Arguments
--job-name -n

數據傳輸作業的名稱。 如果未通過，將會產生隨機作業名稱。

--mode

複製模式（在線/離線）。

屬性 值
預設值: Offline
--src-cassandra

源數據表。

使用方式：--src-cassandra keyspace=XX table=XX' keyspace：Keyspace 名稱。 table：數據表名稱。

屬性 值
參數群組: Azure Cosmos DB API for Apache Cassandra table copy Arguments
--src-mongo

來源集合。

使用方式：--src-mongo 資料庫=XX 集合=XX' 資料庫：資料庫名稱。 集合：集合名稱。

屬性 值
參數群組: Azure Cosmos DB API for MongoDB (RU) collection copy Arguments
--src-nosql

來源容器。

使用方式：--src-nosql 資料庫=XX 容器=XX' 資料庫：資料庫名稱。 容器：容器名稱。

屬性 值
參數群組: Azure Cosmos DB API for NoSQL container copy 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 copy list

預覽

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

取得容器複製作業。

az cosmosdb copy list --account-name
                      --resource-group

範例

列出所有作業

az cosmosdb copy list -g "rg1" --account-name "acc1"

必要參數

--account-name -a

Azure Cosmos DB 帳號名稱，工作建立的地點。 從 create job 命令使用 --dest-account 值。

--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 copy pause

預覽

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

暫停容器複製作業。

az cosmosdb copy pause --account-name
                       --job-name
                       --resource-group
                       [--acquire-policy-token]
                       [--change-reference]

範例

暫停作業 j1

az cosmosdb copy pause -g "rg1" --account-name "acc1" --job-name "j1"

必要參數

--account-name -a

Azure Cosmos DB 帳號名稱，工作建立的地點。 從 create job 命令使用 --dest-account 值。

--job-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 copy resume

預覽

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

繼續容器複製作業。

az cosmosdb copy resume --account-name
                        --job-name
                        --resource-group
                        [--acquire-policy-token]
                        [--change-reference]

範例

繼續作業 j1

az cosmosdb copy resume -g "rg1" --account-name "acc1" --job-name "j1"

必要參數

--account-name -a

Azure Cosmos DB 帳號名稱，工作建立的地點。 從 create job 命令使用 --dest-account 值。

--job-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 copy show

預覽

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

取得容器複製作業。

az cosmosdb copy show --account-name
                      --job-name
                      --resource-group

範例

顯示作業 j1 的詳細數據

az cosmosdb copy show -g "rg1" --account-name "acc1" --job-name "j1"

必要參數

--account-name -a

Azure Cosmos DB 帳號名稱，工作建立的地點。 從 create job 命令使用 --dest-account 值。

--job-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