az cosmosdb mongocluster

注意

此參考是 Azure CLI 的 cosmosdb-preview 延伸模組的一部分 (2.17.1 版或更高版本)。 擴充功能會在您第一次執行 az cosmosdb mongocluster 命令時自動安裝。 深入了解擴充功能。

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

Mongo 叢集。

命令

名稱 Description 類型 狀態
az cosmosdb mongocluster create

建立 Mongo 叢集。

擴充 預覽版
az cosmosdb mongocluster delete

刪除 Mongo 叢集資源。

擴充 預覽版
az cosmosdb mongocluster firewall

Mongo 叢集防火牆。

擴充 預覽版
az cosmosdb mongocluster firewall rule

Mongo 叢集防火牆規則。

擴充 預覽版
az cosmosdb mongocluster firewall rule create

建立 Mongo 叢集防火牆規則。

擴充 預覽版
az cosmosdb mongocluster firewall rule delete

刪除 Mongo 叢集防火牆規則。

擴充 預覽版
az cosmosdb mongocluster firewall rule list

列出 Mongo 叢集上的防火牆規則。

擴充 預覽版
az cosmosdb mongocluster firewall rule show

取得 Mongo 叢集防火牆規則。

擴充 預覽版
az cosmosdb mongocluster firewall rule update

建立 Mongo 叢集防火牆規則。

擴充 預覽版
az cosmosdb mongocluster list

列出 Mongo 叢集資源。

擴充 預覽版
az cosmosdb mongocluster show

取得 Mongo 叢集資源。

擴充 預覽版
az cosmosdb mongocluster update

更新 Mongo 叢集。

擴充 預覽版

az cosmosdb mongocluster create

預覽

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

建立 Mongo 叢集。

az cosmosdb mongocluster create --administrator-login
                                --administrator-login-password
                                --cluster-name
                                --location
                                --resource-group
                                --server-version
                                --shard-node-count
                                --shard-node-disk-size-gb
                                --shard-node-ha {false, true}
                                --shard-node-tier
                                [--tags]

範例

建立 Mongo 叢集。

az cosmosdb mongocluster create \
--cluster-name MyCluster \
--resource-group MyResourceGroup \
--location MyLocation \
--administrator-login MyAdminUser \
--administrator-login-password MyAdminPassword \
--server-version 5.0 \
--shard-node-tier "M30" \
--shard-node-ha true \
--shard-node-disk-size-gb 128 \
--shard-node-count 2

必要參數

--administrator-login -a

建立叢集時要設定的初始系統管理員使用者。

--administrator-login-password -p

建立叢集時要設定的初始系統管理員密碼。

--cluster-name -c

Cosmos DB Mongo 叢集的名稱。

--location -l

叢集的 Azure 位置。

--resource-group -g

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

--server-version

mongo 叢集的伺服器版本。

預設值: 5.0
--shard-node-count

mongo 叢集的節點計數。

預設值: 1
--shard-node-disk-size-gb -d

mongo 叢集的節點磁片大小。

--shard-node-ha

如果已啟用叢集,則具有 HA。

接受的值: false, true
--shard-node-tier

mongo 叢集的節點層。

選擇性參數

--tags

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

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az cosmosdb mongocluster delete

預覽

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

刪除 Mongo 叢集資源。

az cosmosdb mongocluster delete --cluster-name
                                --resource-group
                                [--yes]

範例

刪除 Mongo 叢集資源。 如果叢集不存在,則會傳回 NoContent 回應。

az cosmosdb mongocluster delete --cluster-name MyCluster --resource-group MyResourceGroup

必要參數

--cluster-name -c

Cosmos DB Mongo 叢集的名稱。

--resource-group -g

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

選擇性參數

--yes -y

不提示確認。

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

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az cosmosdb mongocluster list

預覽

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

列出 Mongo 叢集資源。

az cosmosdb mongocluster list [--resource-group]

範例

列出資源群組中的 Mongo 叢集資源清單。

az cosmosdb mongocluster list --resource-group MyResourceGroup

列出訂用帳戶中的 Mongo 叢集資源清單。

az cosmosdb mongocluster list

選擇性參數

--resource-group -g

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

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az cosmosdb mongocluster show

預覽

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

取得 Mongo 叢集資源。

az cosmosdb mongocluster show --cluster-name
                              --resource-group

範例

取得 Mongo 叢集資源。 ProvisioningState 會告知此叢集的狀態。 如果叢集不存在,則會傳回 NotFound 回應。

az cosmosdb mongocluster show --cluster-name MyCluster --resource-group MyResourceGroup

必要參數

--cluster-name -c

Cosmos DB Mongo 叢集的名稱。

--resource-group -g

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

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az cosmosdb mongocluster update

預覽

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

更新 Mongo 叢集。

az cosmosdb mongocluster update --cluster-name
                                --resource-group
                                [--administrator-login]
                                [--administrator-login-password]
                                [--server-version]
                                [--shard-node-disk-size-gb]
                                [--shard-node-ha {false, true}]
                                [--shard-node-tier]
                                [--tags]

範例

更新 Mongo 叢集。

az cosmosdb mongocluster update \
--cluster-name MyCluster \
--resource-group MyResourceGroup \
--administrator-login MyAdminUser \
--administrator-login-password MyAdminPassword \
--server-version 5.0 \
--shard-node-tier "M30" \
--shard-node-ha true \
--shard-node-disk-size-gb 128

必要參數

--cluster-name -c

Cosmos DB Mongo 叢集的名稱。

--resource-group -g

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

選擇性參數

--administrator-login -a

建立叢集時要設定的初始系統管理員使用者。

--administrator-login-password -p

建立叢集時要設定的初始系統管理員密碼。

--server-version

mongo 叢集的伺服器版本。

--shard-node-disk-size-gb -d

mongo 叢集的節點磁片大小。

--shard-node-ha

如果已啟用叢集,則具有 HA。

接受的值: false, true
--shard-node-tier

mongo 叢集的節點層。

--tags

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

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

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

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

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。