az documentdb mongocluster

Note

To odwołanie jest częścią rozszerzenia documentdb dla Azure CLI (wersja 2.75.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane po pierwszym uruchomieniu polecenia az documentdb mongocluster . Dowiedz się więcej o rozszerzeniach.

Grupa poleceń "az documentdb" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Zarządzanie klastrami mongo usługi DocumentDB Azure.

Polecenia

Nazwa	Opis	Typ	Stan
az documentdb mongocluster check-name-availability	Sprawdź, czy nazwa klastra mongo jest dostępna do użycia.	Extension	Preview
az documentdb mongocluster create	Utwórz klaster mongo. Aktualizacja zastępuje wszystkie właściwości zasobu. Aby zmodyfikować tylko niektóre właściwości, użyj funkcji PATCH.	Extension	Preview
az documentdb mongocluster delete	Usuwanie klastra mongo.	Extension	Preview
az documentdb mongocluster firewall-rule	Zarządzanie regułą zapory.	Extension	Preview
az documentdb mongocluster firewall-rule create	Utwórz nową regułę zapory lub zaktualizuj istniejącą regułę zapory w klastrze mongo.	Extension	Preview
az documentdb mongocluster firewall-rule delete	Usuń regułę zapory klastra mongo.	Extension	Preview
az documentdb mongocluster firewall-rule list	Wyświetl listę wszystkich reguł zapory w danym klastrze mongo.	Extension	Preview
az documentdb mongocluster firewall-rule show	Uzyskaj informacje o regule zapory klastra mongo.	Extension	Preview
az documentdb mongocluster firewall-rule update	Zaktualizuj nową regułę zapory lub zaktualizuj istniejącą regułę zapory w klastrze mongo.	Extension	Preview
az documentdb mongocluster firewall-rule wait	Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku.	Extension	Preview
az documentdb mongocluster identity	Zarządzanie tożsamością.	Extension	Preview
az documentdb mongocluster identity assign	Przypisz tożsamości zarządzane przez użytkownika lub system.	Extension	Preview
az documentdb mongocluster identity list	Wyświetl listę tożsamości zarządzanych przypisanych do klastra mongo.	Extension	Preview
az documentdb mongocluster identity remove	Usuń tożsamości zarządzane przez użytkownika lub system.	Extension	Preview
az documentdb mongocluster identity show	Pokaż szczegóły tożsamości zarządzanych.	Extension	Preview
az documentdb mongocluster identity wait	Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku.	Extension	Preview
az documentdb mongocluster list	Wyświetl listę wszystkich klastrów mongo w danej subskrypcji.	Extension	Preview
az documentdb mongocluster list-connection-strings	Wyświetl listę parametrów połączenia klastra mongo. Obejmuje to domyślne parametry połączenia przy użyciu protokołu SCRAM-SHA-256, a także inne parametry połączenia obsługiwane przez klaster.	Extension	Preview
az documentdb mongocluster microsoft-entra-user	Zarządzanie użytkownikami Microsoft Entra ID w klastrze mongo.	Extension	Preview
az documentdb mongocluster microsoft-entra-user assign	Przyznaj Microsoft Entra ID głównemu dostępowi do klastra mongo, przypisując mu role bazy danych.	Extension	Preview
az documentdb mongocluster microsoft-entra-user list	Wyświetl listę użytkowników Microsoft Entra ID w klastrze mongo.	Extension	Preview
az documentdb mongocluster microsoft-entra-user remove	Usuń dostęp podmiotu zabezpieczeń Microsoft Entra ID z klastra mongo.	Extension	Preview
az documentdb mongocluster microsoft-entra-user show	Pobierz definicję użytkownika Microsoft Entra ID w klastrze mongo.	Extension	Preview
az documentdb mongocluster microsoft-entra-user wait	Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku.	Extension	Preview
az documentdb mongocluster replica	Zarządzanie repliką.	Extension	Preview
az documentdb mongocluster replica create	Utwórz replikę do odczytu istniejącego klastra mongo.	Extension	Preview
az documentdb mongocluster replica list	Wyświetl listę wszystkich replik klastra mongo.	Extension	Preview
az documentdb mongocluster replica promote	Promuje klaster mongo repliki do roli podstawowej.	Extension	Preview
az documentdb mongocluster reset-password	Zresetuj hasło administratora klastra mongo.	Extension	Preview
az documentdb mongocluster restore	Przywracanie klastra mongo do nowego klastra z punktu w czasie.	Extension	Preview
az documentdb mongocluster show	Uzyskaj informacje o klastrze mongo.	Extension	Preview
az documentdb mongocluster update	Aktualizowanie klastra mongo. Modyfikowane są tylko właściwości określone w żądaniu; wszystkie inne właściwości pozostają niezmienione (HTTP PATCH). Obsługiwane są ogólne argumenty aktualizacji (--set, --add, --remove).	Extension	Preview
az documentdb mongocluster wait	Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku.	Extension	Preview

az documentdb mongocluster check-name-availability

Wersja zapoznawcza

Grupa poleceń "az documentdb mongocluster" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Sprawdź, czy nazwa klastra mongo jest dostępna do użycia.

az documentdb mongocluster check-name-availability [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--ids]
                                                   [--location]
                                                   [--name]
                                                   [--subscription]
                                                   [--type]

Przykłady

Sprawdź, czy nazwa klastra mongo jest dostępna.

az documentdb mongocluster check-name-availability --location eastus --name MyCluster

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--location -l

Location. Wartości z: az account list-locations. Lokalizację domyślną można skonfigurować przy użyciu polecenia az configure --defaults location=<location>.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--name

Nazwa zasobu, dla którego należy sprawdzić dostępność.

Właściwość	Wartość
Grupa parametrów:	Body Arguments

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--type

Typ zasobu.

Właściwość	Wartość
Grupa parametrów:	Body Arguments
Domyślna wartość:	Microsoft.DocumentDB/mongoClusters

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az documentdb mongocluster create

Wersja zapoznawcza

Grupa poleceń "az documentdb mongocluster" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Utwórz klaster mongo. Aktualizacja zastępuje wszystkie właściwości zasobu. Aby zmodyfikować tylko niektóre właściwości, użyj funkcji PATCH.

az documentdb mongocluster create --admin-password --password
                                  --admin-user
                                  --cluster-name --name
                                  --high-availability {Disabled, SameZone, ZoneRedundantPreferred}
                                  --resource-group
                                  --shard-count
                                  --storage-size
                                  --tier
                                  [--acquire-policy-token]
                                  [--auth-allowed-modes]
                                  [--change-reference]
                                  [--data-api-mode {Disabled, Enabled}]
                                  [--encryption]
                                  [--location]
                                  [--mi-user-assigned --user-assigned]
                                  [--network-bypass-mode {AzureCosmosDB, None}]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--preview-features]
                                  [--public-network-access {Disabled, Enabled}]
                                  [--server-version]
                                  [--storage-type {PremiumSSD, PremiumSSDv2}]
                                  [--tags]

Przykłady

Utwórz klaster mongo z magazynem SSD w wersji 2 w warstwie Premium.

az documentdb mongocluster create -n MyCluster -g MyResourceGroup --location eastus --admin-user dbadmin --admin-password MyP@ssw0rd123! --tier M30 --storage-size 128 --storage-type PremiumSSDv2 --shard-count 1 --high-availability Disabled

Parametry wymagane

--admin-password --password -p

Hasło administratora. Jeśli wartość jest pusta, zostanie wyświetlony monit z tty.

Właściwość	Wartość
Grupa parametrów:	Administrator Arguments

--admin-user -u

Nazwa użytkownika administratora.

Właściwość	Wartość
Grupa parametrów:	Administrator Arguments

--cluster-name --name -n

Nazwa klastra mongo.

--high-availability

Docelowy tryb wysokiej dostępności żądany dla klastra.

Właściwość	Wartość
Grupa parametrów:	HighAvailability Arguments
Dopuszczalne wartości:	Disabled, SameZone, ZoneRedundantPreferred

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--shard-count

Liczba fragmentów do aprowizacji w klastrze.

Właściwość	Wartość
Grupa parametrów:	Sharding Arguments

--storage-size

Rozmiar dysku danych przypisany do każdego serwera.

Właściwość	Wartość
Grupa parametrów:	Storage Arguments

--tier

Warstwa obliczeniowa do przypisania do klastra, w której każda warstwa jest mapowana na rozmiar rdzenia wirtualnego i pamięci. Przykładowe wartości: "M30", "M40".

Właściwość	Wartość
Grupa parametrów:	Compute Arguments

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--auth-allowed-modes

Rozdzielona spacjami lista dozwolonych trybów uwierzytelniania na potrzeby dostępu do danych. Dozwolone wartości: NativeAuth, MicrosoftEntraID. Przykład: --auth-allowed-modes NativeAuth MicrosoftEntraID Support shorthand-syntax, json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	AuthConfig Arguments

--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--data-api-mode

Włącz lub wyłącz interfejs API danych Mongo w klastrze. Dozwolone wartości: Enabled (Włączone) i Disabled (Wyłączone). Przykład: --data-api-mode włączone.

Właściwość	Wartość
Grupa parametrów:	DataApi Arguments
Dopuszczalne wartości:	Disabled, Enabled

--encryption

Konfiguracja szyfrowania dla klastra. Zależy od konfigurowanej tożsamości. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--location -l

Lokalizacja geograficzna, w której znajduje się zasób, gdy nie zostanie określony, zostanie użyta lokalizacja grupy zasobów.

Właściwość	Wartość
Grupa parametrów:	Resource Arguments

--mi-user-assigned --user-assigned

Ustaw tożsamości zarządzane przez użytkownika. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	Identity Arguments

--network-bypass-mode

Tryb omijania sieci dla klastra. Ustawienie na 'AzureCosmosDB' pozwala usłudze Azure Cosmos DB omijać ograniczenia sieciowe.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments
Dopuszczalne wartości:	AzureCosmosDB, None

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

Właściwość	Wartość
Dopuszczalne wartości:	0, 1, f, false, n, no, t, true, y, yes

--preview-features

Rozdzielona spacjami lista funkcji w wersji zapoznawczej, które mają być włączone w klastrze. Nazwy funkcji w wersji zapoznawczej są ciągami bez formularzy; Zapoznaj się z dokumentacją funkcji klastra mongo, aby zapoznać się z aktualnie dostępnymi wartościami. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--public-network-access

Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego klastra mongo.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments
Dopuszczalne wartości:	Disabled, Enabled

--server-version

Wersja serwera Mongo DB. Wartość domyślna to najnowsza dostępna wersja, jeśli nie zostanie określona.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--storage-type

Typ magazynu, który ma być obsługiwany przez serwery klastra.

Właściwość	Wartość
Grupa parametrów:	Storage Arguments
Dopuszczalne wartości:	PremiumSSD, PremiumSSDv2

--tags

Tagi zasobów. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	Resource Arguments

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az documentdb mongocluster delete

Wersja zapoznawcza

Grupa poleceń "az documentdb mongocluster" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Usuwanie klastra mongo.

az documentdb mongocluster delete [--acquire-policy-token]
                                  [--change-reference]
                                  [--cluster-name --name]
                                  [--ids]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--resource-group]
                                  [--subscription]
                                  [--yes]

Przykłady

Usuwanie klastra mongo.

az documentdb mongocluster delete -n MyCluster -g MyResourceGroup

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--cluster-name --name -n

Nazwa klastra mongo.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

Właściwość	Wartość
Dopuszczalne wartości:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--yes -y

Nie monituj o potwierdzenie.

Właściwość	Wartość
Domyślna wartość:	False

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az documentdb mongocluster list

Wersja zapoznawcza

Grupa poleceń "az documentdb mongocluster" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Wyświetl listę wszystkich klastrów mongo w danej subskrypcji.

az documentdb mongocluster list [--max-items]
                                [--next-token]
                                [--resource-group]

Przykłady

Wyświetl listę wszystkich klastrów mongo w grupie zasobów.

az documentdb mongocluster list -g MyResourceGroup

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--max-items

Łączna liczba elementów do zwrócenia w danych wyjściowych polecenia. Jeśli łączna liczba dostępnych elementów jest większa niż określona wartość, token jest udostępniany w danych wyjściowych polecenia. Aby wznowić stronicowanie, podaj wartość tokenu w --next-token argumentu kolejnego polecenia.

Właściwość	Wartość
Grupa parametrów:	Pagination Arguments

--next-token

Token do określenia, gdzie rozpocząć stronicowanie. Jest to wartość tokenu z wcześniej obciętej odpowiedzi.

Właściwość	Wartość
Grupa parametrów:	Pagination Arguments

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az documentdb mongocluster list-connection-strings

Wersja zapoznawcza

Grupa poleceń "az documentdb mongocluster" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Wyświetl listę parametrów połączenia klastra mongo. Obejmuje to domyślne parametry połączenia przy użyciu protokołu SCRAM-SHA-256, a także inne parametry połączenia obsługiwane przez klaster.

az documentdb mongocluster list-connection-strings [--acquire-policy-token]
                                                   [--change-reference]
                                                   [--cluster-name]
                                                   [--ids]
                                                   [--resource-group]
                                                   [--subscription]

Przykłady

Wyświetl listę parametrów połączenia dla klastra mongo.

az documentdb mongocluster list-connection-strings --cluster-name MyCluster -g MyResourceGroup

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--cluster-name

Nazwa klastra mongo.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az documentdb mongocluster reset-password

Wersja zapoznawcza

Grupa poleceń "az documentdb mongocluster" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Zresetuj hasło administratora klastra mongo.

az documentdb mongocluster reset-password --admin-password --password
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--cluster-name --name]
                                          [--ids]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--resource-group]
                                          [--subscription]

Przykłady

Zresetuj hasło administratora.

az documentdb mongocluster reset-password -n MyCluster -g MyResourceGroup --admin-password NewP@ssw0rd123!

Parametry wymagane

--admin-password --password -p

Nowe hasło administratora. Jeśli wartość jest pusta, zostanie wyświetlony monit z tty.

Właściwość	Wartość
Grupa parametrów:	Administrator Arguments

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--cluster-name --name -n

Nazwa klastra mongo.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

Właściwość	Wartość
Dopuszczalne wartości:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az documentdb mongocluster restore

Wersja zapoznawcza

Grupa poleceń "az documentdb mongocluster" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Przywracanie klastra mongo do nowego klastra z punktu w czasie.

Tworzy nowy klaster mongo z kopii zapasowej istniejącego (lub usuniętego) klastra źródłowego w żądanym punkcie w czasie.

az documentdb mongocluster restore --admin-password --password
                                   --admin-user
                                   --cluster-name --name
                                   --resource-group
                                   --restore-time
                                   --source-cluster
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--location]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Przykłady

Przywracanie klastra do punktu w czasie.

az documentdb mongocluster restore -n RestoredCluster -g MyResourceGroup --location eastus2 --source-cluster MySourceCluster --restore-time "2026-06-30T10:00:00Z" --admin-user dbadmin --admin-password MyP@ssw0rd123!

Parametry wymagane

--admin-password --password -p

Hasło administratora. Jeśli wartość jest pusta, zostanie wyświetlony monit z tty.

Właściwość	Wartość
Grupa parametrów:	Administrator Arguments

--admin-user -u

Nazwa użytkownika administratora.

Właściwość	Wartość
Grupa parametrów:	Administrator Arguments

--cluster-name --name -n

Nazwa klastra mongo.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--restore-time

Punkt CZASU UTC do przywrócenia w formacie ISO-8601 (na przykład: 2026-06-30T10:00:00Z).

Właściwość	Wartość
Grupa parametrów:	Restore Arguments

--source-cluster

Nazwa lub identyfikator zasobu źródłowego klastra mongo do przywrócenia. Jeśli nadano nazwę, przyjmuje się bieżącą subskrypcję i grupę zasobów.

Właściwość	Wartość
Grupa parametrów:	Restore Arguments

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--location -l

Lokalizacja geograficzna, w której znajduje się zasób, gdy nie zostanie określony, zostanie użyta lokalizacja grupy zasobów.

Właściwość	Wartość
Grupa parametrów:	Resource Arguments

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

Właściwość	Wartość
Dopuszczalne wartości:	0, 1, f, false, n, no, t, true, y, yes

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az documentdb mongocluster show

Wersja zapoznawcza

Grupa poleceń "az documentdb mongocluster" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Uzyskaj informacje o klastrze mongo.

az documentdb mongocluster show [--cluster-name --name]
                                [--ids]
                                [--resource-group]
                                [--subscription]

Przykłady

Uzyskaj informacje o klastrze mongo.

az documentdb mongocluster show -n MyCluster -g MyResourceGroup

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--cluster-name --name -n

Nazwa klastra mongo.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az documentdb mongocluster update

Wersja zapoznawcza

Grupa poleceń "az documentdb mongocluster" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Aktualizowanie klastra mongo. Modyfikowane są tylko właściwości określone w żądaniu; wszystkie inne właściwości pozostają niezmienione (HTTP PATCH). Obsługiwane są ogólne argumenty aktualizacji (--set, --add, --remove).

az documentdb mongocluster update [--acquire-policy-token]
                                  [--add]
                                  [--admin-password --password]
                                  [--admin-user]
                                  [--auth-allowed-modes]
                                  [--change-reference]
                                  [--cluster-name --name]
                                  [--data-api-mode {Disabled, Enabled}]
                                  [--encryption]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--high-availability {Disabled, SameZone, ZoneRedundantPreferred}]
                                  [--ids]
                                  [--network-bypass-mode {AzureCosmosDB, None}]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--preview-features]
                                  [--public-network-access {Disabled, Enabled}]
                                  [--remove]
                                  [--resource-group]
                                  [--server-version]
                                  [--set]
                                  [--shard-count]
                                  [--storage-size]
                                  [--storage-type {PremiumSSD, PremiumSSDv2}]
                                  [--subscription]
                                  [--tags]
                                  [--tier]

Przykłady

Aktualizowanie warstwy obliczeniowej klastra mongo.

az documentdb mongocluster update -n MyCluster -g MyResourceGroup --tier M40

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--add

Dodaj obiekt do listy obiektów, określając pary ścieżki i wartości klucza. Przykład: --add property.listProperty <key=value, string or JSON string>.

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments

--admin-password --password -p

Hasło administratora. Jeśli wartość jest pusta, zostanie wyświetlony monit z tty.

Właściwość	Wartość
Grupa parametrów:	Administrator Arguments

--admin-user -u

Nazwa użytkownika administratora.

Właściwość	Wartość
Grupa parametrów:	Administrator Arguments

--auth-allowed-modes

Rozdzielona spacjami lista dozwolonych trybów uwierzytelniania na potrzeby dostępu do danych. Dozwolone wartości: NativeAuth, MicrosoftEntraID. Przykład: --auth-allowed-modes NativeAuth MicrosoftEntraID Support shorthand-syntax, json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	AuthConfig Arguments

--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--cluster-name --name -n

Nazwa klastra mongo.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--data-api-mode

Włącz lub wyłącz interfejs API danych Mongo w klastrze. Dozwolone wartości: Enabled (Włączone) i Disabled (Wyłączone). Przykład: --data-api-mode włączone.

Właściwość	Wartość
Grupa parametrów:	DataApi Arguments
Dopuszczalne wartości:	Disabled, Enabled

--encryption

Konfiguracja szyfrowania dla klastra. Zależy od konfigurowanej tożsamości. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--force-string

W przypadku używania polecenia "set" lub "add" zachowaj literały ciągu zamiast próbować konwertować na format JSON.

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments
Dopuszczalne wartości:	0, 1, f, false, n, no, t, true, y, yes

--high-availability

Docelowy tryb wysokiej dostępności żądany dla klastra.

Właściwość	Wartość
Grupa parametrów:	HighAvailability Arguments
Dopuszczalne wartości:	Disabled, SameZone, ZoneRedundantPreferred

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--network-bypass-mode

Tryb omijania sieci dla klastra. Ustawienie na 'AzureCosmosDB' pozwala usłudze Azure Cosmos DB omijać ograniczenia sieciowe.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments
Dopuszczalne wartości:	AzureCosmosDB, None

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

Właściwość	Wartość
Dopuszczalne wartości:	0, 1, f, false, n, no, t, true, y, yes

--preview-features

Rozdzielona spacjami lista funkcji w wersji zapoznawczej, które mają być włączone w klastrze. Nazwy funkcji w wersji zapoznawczej są ciągami bez formularzy; Zapoznaj się z dokumentacją funkcji klastra mongo, aby zapoznać się z aktualnie dostępnymi wartościami. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--public-network-access

Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego klastra mongo.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments
Dopuszczalne wartości:	Disabled, Enabled

--remove

Usuń właściwość lub element z listy. Przykład: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--server-version

Wersja serwera Mongo DB. Wartość domyślna to najnowsza dostępna wersja, jeśli nie zostanie określona.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--set

Zaktualizuj obiekt, określając ścieżkę właściwości i wartość do ustawienia. Przykład: --set property1.property2=<value>.

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments

--shard-count

Liczba fragmentów do aprowizacji w klastrze.

Właściwość	Wartość
Grupa parametrów:	Sharding Arguments

--storage-size

Rozmiar dysku danych przypisany do każdego serwera.

Właściwość	Wartość
Grupa parametrów:	Storage Arguments

--storage-type

Typ magazynu, który ma być obsługiwany przez serwery klastra.

Właściwość	Wartość
Grupa parametrów:	Storage Arguments
Dopuszczalne wartości:	PremiumSSD, PremiumSSDv2

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--tags

Tagi zasobów. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	Resource Arguments

--tier

Warstwa obliczeniowa do przypisania do klastra, w której każda warstwa jest mapowana na rozmiar rdzenia wirtualnego i pamięci. Przykładowe wartości: "M30", "M40".

Właściwość	Wartość
Grupa parametrów:	Compute Arguments

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az documentdb mongocluster wait

Wersja zapoznawcza

Grupa poleceń "az documentdb mongocluster" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku.

az documentdb mongocluster wait [--acquire-policy-token]
                                [--change-reference]
                                [--cluster-name --name]
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--ids]
                                [--interval]
                                [--resource-group]
                                [--subscription]
                                [--timeout]
                                [--updated]

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--acquire-policy-token

Automatyczne uzyskiwanie tokenu Azure Policy dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--change-reference

Powiązany identyfikator odwołania do zmiany dla tej operacji zasobu.

Właściwość	Wartość
Grupa parametrów:	Global Policy Arguments

--cluster-name --name -n

Nazwa klastra mongo.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--created

Zaczekaj na utworzenie polecenia "provisioningState" o godzinie "Succeeded".

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	False

--custom

Poczekaj, aż warunek spełnia niestandardowe zapytanie JMESPath. Np. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments

--deleted

Poczekaj na usunięcie.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	False

--exists

Zaczekaj, aż zasób istnieje.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	False

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--interval

Interwał sondowania w sekundach.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	30

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--timeout

Maksymalny czas oczekiwania w sekundach.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	3600

--updated

Zaczekaj na zaktualizowanie stanu provisioningState o 'Powodzenie'.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	False

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False