az documentdb mongocluster

Förhandsversion

Note

Den här referensen är en del av documentdb-tillägget för Azure CLI (version 2.75.0 eller senare). Tillägget installeras automatiskt första gången du kör kommandot az documentdb mongocluster . Läs mer om tillägg.

Kommandogruppen "az documentdb" finns i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hantera Azure DocumentDB mongo-kluster.

Kommandon

Name	Description	Typ	Status
az documentdb mongocluster check-name-availability	Kontrollera om mongo-klusternamnet är tillgängligt för användning.	Extension	Preview
az documentdb mongocluster create	Skapa ett mongo-kluster. Uppdatera skriver över alla egenskaper för resursen. Om du bara vill ändra vissa av egenskaperna använder du PATCH.	Extension	Preview
az documentdb mongocluster delete	Ta bort ett mongo-kluster.	Extension	Preview
az documentdb mongocluster firewall-rule	Hantera brandväggsregel.	Extension	Preview
az documentdb mongocluster firewall-rule create	Skapa en ny brandväggsregel eller uppdatera en befintlig brandväggsregel i ett mongo-kluster.	Extension	Preview
az documentdb mongocluster firewall-rule delete	Ta bort en brandväggsregel för mongo-kluster.	Extension	Preview
az documentdb mongocluster firewall-rule list	Visa en lista över alla brandväggsregler i ett visst mongo-kluster.	Extension	Preview
az documentdb mongocluster firewall-rule show	Hämta information om en brandväggsregel för mongo-kluster.	Extension	Preview
az documentdb mongocluster firewall-rule update	Uppdatera en ny brandväggsregel eller uppdatera en befintlig brandväggsregel i ett mongo-kluster.	Extension	Preview
az documentdb mongocluster firewall-rule wait	Placera CLI i vänteläge tills ett villkor uppfylls.	Extension	Preview
az documentdb mongocluster identity	Hantera identitet.	Extension	Preview
az documentdb mongocluster identity assign	Tilldela användar- eller systemhanterade identiteter.	Extension	Preview
az documentdb mongocluster identity list	Visa en lista över hanterade identiteter som tilldelats till ett mongo-kluster.	Extension	Preview
az documentdb mongocluster identity remove	Ta bort användar- eller systemhanterade identiteter.	Extension	Preview
az documentdb mongocluster identity show	Visa information om hanterade identiteter.	Extension	Preview
az documentdb mongocluster identity wait	Placera CLI i vänteläge tills ett villkor uppfylls.	Extension	Preview
az documentdb mongocluster list	Visa en lista över alla mongo-kluster i en viss prenumeration.	Extension	Preview
az documentdb mongocluster list-connection-strings	Lista mongo-klusteranslutningssträngar. Detta inkluderar standardanslutningssträngen med hjälp av SCRAM-SHA-256, samt andra anslutningssträngar som stöds av klustret.	Extension	Preview
az documentdb mongocluster microsoft-entra-user	Hantera Microsoft Entra ID användare i ett mongo-kluster.	Extension	Preview
az documentdb mongocluster microsoft-entra-user assign	Ge ett Microsoft Entra ID huvudnamn åtkomst till ett mongo-kluster genom att tilldela det databasroller.	Extension	Preview
az documentdb mongocluster microsoft-entra-user list	Visa en lista över Microsoft Entra ID användare i ett mongo-kluster.	Extension	Preview
az documentdb mongocluster microsoft-entra-user remove	Ta bort ett Microsoft Entra ID huvudnamns åtkomst från ett mongo-kluster.	Extension	Preview
az documentdb mongocluster microsoft-entra-user show	Hämta definitionen av en Microsoft Entra ID användare i ett mongo-kluster.	Extension	Preview
az documentdb mongocluster microsoft-entra-user wait	Placera CLI i vänteläge tills ett villkor uppfylls.	Extension	Preview
az documentdb mongocluster replica	Hantera replik.	Extension	Preview
az documentdb mongocluster replica create	Skapa en läsreplik av ett befintligt mongo-kluster.	Extension	Preview
az documentdb mongocluster replica list	Visa en lista över alla repliker för mongo-klustret.	Extension	Preview
az documentdb mongocluster replica promote	Höjer upp ett mongo-replikkluster till en primär roll.	Extension	Preview
az documentdb mongocluster reset-password	Återställ administratörslösenordet för ett mongo-kluster.	Extension	Preview
az documentdb mongocluster restore	Återställa ett mongo-kluster till ett nytt kluster från en tidpunkt.	Extension	Preview
az documentdb mongocluster show	Hämta information om ett mongo-kluster.	Extension	Preview
az documentdb mongocluster update	Uppdatera ett mongo-kluster. Endast de egenskaper som anges i begäran ändras. alla andra egenskaper lämnas oförändrade (HTTP PATCH). Allmänna uppdateringsargument (--set, --add, --remove) stöds.	Extension	Preview
az documentdb mongocluster wait	Placera CLI i vänteläge tills ett villkor uppfylls.	Extension	Preview

az documentdb mongocluster check-name-availability

Förhandsversion

Kommandogruppen "az documentdb mongocluster" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Kontrollera om mongo-klusternamnet är tillgängligt för användning.

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

Exempel

Kontrollera om ett mongo-klusternamn är tillgängligt.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--location -l

Location. Värden från: az account list-locations. Du kan konfigurera standardplatsen med hjälp av az configure --defaults location=<location>.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--name

Namnet på resursen som tillgängligheten måste kontrolleras för.

Egenskap	Värde
Parametergrupp:	Body Arguments

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--type

Resurstypen.

Egenskap	Värde
Parametergrupp:	Body Arguments
Standardvärde:	Microsoft.DocumentDB/mongoClusters

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

az documentdb mongocluster create

Förhandsversion

Kommandogruppen "az documentdb mongocluster" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Skapa ett mongo-kluster. Uppdatera skriver över alla egenskaper för resursen. Om du bara vill ändra vissa av egenskaperna använder du 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]

Exempel

Skapa ett mongo-kluster med Premium SSD v2-lagring.

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

Obligatoriska parametrar

--admin-password --password -p

Administratörslösenordet. Om värdet är tomt efterfrågas det från tty.tty.

Egenskap	Värde
Parametergrupp:	Administrator Arguments

--admin-user -u

Administratörens användarnamn.

Egenskap	Värde
Parametergrupp:	Administrator Arguments

--cluster-name --name -n

Namnet på mongo-klustret.

--high-availability

Det målläge för hög tillgänglighet som begärs för klustret.

Egenskap	Värde
Parametergrupp:	HighAvailability Arguments
Godkända värden:	Disabled, SameZone, ZoneRedundantPreferred

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--shard-count

Antal shards som ska etableras i klustret.

Egenskap	Värde
Parametergrupp:	Sharding Arguments

--storage-size

Storleken på den datadisk som tilldelats till varje server.

Egenskap	Värde
Parametergrupp:	Storage Arguments

--tier

Beräkningsnivån som ska tilldelas till klustret, där varje nivå mappas till en virtuell kärna och minnesstorlek. Exempelvärden: "M30", "M40".

Egenskap	Värde
Parametergrupp:	Compute Arguments

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--auth-allowed-modes

Utrymmesavgränsad lista över tillåtna autentiseringslägen för dataåtkomst. Tillåtna värden: NativeAuth, MicrosoftEntraID. Exempel: --auth-allowed-modes NativeAuth MicrosoftEntraID Support shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap	Värde
Parametergrupp:	AuthConfig Arguments

--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--data-api-mode

Aktivera eller inaktivera Mongo-data-API:et i klustret. Tillåtna värden: Aktiverad, Inaktiverad. Exempel: --data-api-mode Aktiverat.

Egenskap	Värde
Parametergrupp:	DataApi Arguments
Godkända värden:	Disabled, Enabled

--encryption

Krypteringskonfigurationen för klustret. Beror på vilken identitet som har konfigurerats. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--location -l

Den geo-plats där resursen finns När den inte anges används platsen för resursgruppen.

Egenskap	Värde
Parametergrupp:	Resource Arguments

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

Ange användarhanterade identiteter. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap	Värde
Parametergrupp:	Identity Arguments

--network-bypass-mode

Nätverksbypass-läget för klustret. Att ställa in på 'AzureCosmosDB' tillåter Azure Cosmos DB-tjänst att kringgå nätverksbegränsningar.

Egenskap	Värde
Parametergrupp:	Properties Arguments
Godkända värden:	AzureCosmosDB, None

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap	Värde
Godkända värden:	0, 1, f, false, n, no, t, true, y, yes

--preview-features

Utrymmesavgränsad lista över förhandsgranskningsfunktioner som ska aktiveras i klustret. Förhandsgranskningsfunktionsnamn är fria formulärsträngar. Se funktionsdokumentationen för mongo-klustret för de värden som är tillgängliga för närvarande. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--public-network-access

Om offentlig slutpunktsåtkomst tillåts för det här mongo-klustret eller inte.

Egenskap	Värde
Parametergrupp:	Properties Arguments
Godkända värden:	Disabled, Enabled

--server-version

Mongo DB-serverversionen. Standardvärdet är den senaste tillgängliga versionen om den inte har angetts.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--storage-type

Den typ av lagring som klusterservrarna ska etableras med.

Egenskap	Värde
Parametergrupp:	Storage Arguments
Godkända värden:	PremiumSSD, PremiumSSDv2

--tags

Resursetiketter. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap	Värde
Parametergrupp:	Resource Arguments

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

az documentdb mongocluster delete

Förhandsversion

Kommandogruppen "az documentdb mongocluster" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Ta bort ett mongo-kluster.

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]

Exempel

Ta bort ett mongo-kluster.

az documentdb mongocluster delete -n MyCluster -g MyResourceGroup

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--cluster-name --name -n

Namnet på mongo-klustret.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--ids

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap	Värde
Godkända värden:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--yes -y

Fråga inte efter bekräftelse.

Egenskap	Värde
Standardvärde:	False

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

az documentdb mongocluster list

Förhandsversion

Kommandogruppen "az documentdb mongocluster" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Visa en lista över alla mongo-kluster i en viss prenumeration.

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

Exempel

Visa en lista över alla mongo-kluster i en resursgrupp.

az documentdb mongocluster list -g MyResourceGroup

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--max-items

Totalt antal objekt som ska returneras i kommandots utdata. Om det totala antalet tillgängliga objekt är mer än det angivna värdet anges en token i kommandots utdata. Om du vill återuppta sidnumreringen anger du tokenvärdet i --next-token argument för ett efterföljande kommando.

Egenskap	Värde
Parametergrupp:	Pagination Arguments

--next-token

Token för att ange var sidnumrering ska börja. Detta är tokenvärdet från ett tidigare trunkerat svar.

Egenskap	Värde
Parametergrupp:	Pagination Arguments

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

az documentdb mongocluster list-connection-strings

Förhandsversion

Kommandogruppen "az documentdb mongocluster" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Lista mongo-klusteranslutningssträngar. Detta inkluderar standardanslutningssträngen med hjälp av SCRAM-SHA-256, samt andra anslutningssträngar som stöds av klustret.

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

Exempel

Visa en lista över anslutningssträngar för ett mongo-kluster.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--cluster-name

Namnet på mongo-klustret.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--ids

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

az documentdb mongocluster reset-password

Förhandsversion

Kommandogruppen "az documentdb mongocluster" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Återställ administratörslösenordet för ett mongo-kluster.

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]

Exempel

Återställ administratörslösenordet.

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

Obligatoriska parametrar

--admin-password --password -p

Det nya administratörslösenordet. Om värdet är tomt efterfrågas det från tty.tty.

Egenskap	Värde
Parametergrupp:	Administrator Arguments

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--cluster-name --name -n

Namnet på mongo-klustret.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--ids

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap	Värde
Godkända värden:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

az documentdb mongocluster restore

Förhandsversion

Kommandogruppen "az documentdb mongocluster" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Återställa ett mongo-kluster till ett nytt kluster från en tidpunkt.

Skapar ett nytt mongo-kluster från säkerhetskopieringen av ett befintligt (eller borttaget) källkluster vid den begärda tidpunkten.

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}]

Exempel

Återställ ett kluster till en tidpunkt.

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!

Obligatoriska parametrar

--admin-password --password -p

Administratörslösenordet. Om värdet är tomt efterfrågas det från tty.tty.

Egenskap	Värde
Parametergrupp:	Administrator Arguments

--admin-user -u

Administratörens användarnamn.

Egenskap	Värde
Parametergrupp:	Administrator Arguments

--cluster-name --name -n

Namnet på mongo-klustret.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--restore-time

UTC-tidpunkt för återställning från i ISO-8601-format (till exempel: 2026-06-30T10:00:00Z).

Egenskap	Värde
Parametergrupp:	Restore Arguments

--source-cluster

Namn eller resurs-ID för det mongo-källkluster som ska återställas från. Om ett namn anges antas den aktuella prenumerationen och resursgruppen.

Egenskap	Värde
Parametergrupp:	Restore Arguments

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--location -l

Den geo-plats där resursen finns När den inte anges används platsen för resursgruppen.

Egenskap	Värde
Parametergrupp:	Resource Arguments

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap	Värde
Godkända värden:	0, 1, f, false, n, no, t, true, y, yes

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

az documentdb mongocluster show

Förhandsversion

Kommandogruppen "az documentdb mongocluster" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hämta information om ett mongo-kluster.

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

Exempel

Hämta information om ett mongo-kluster.

az documentdb mongocluster show -n MyCluster -g MyResourceGroup

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--cluster-name --name -n

Namnet på mongo-klustret.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--ids

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

az documentdb mongocluster update

Förhandsversion

Kommandogruppen "az documentdb mongocluster" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Uppdatera ett mongo-kluster. Endast de egenskaper som anges i begäran ändras. alla andra egenskaper lämnas oförändrade (HTTP PATCH). Allmänna uppdateringsargument (--set, --add, --remove) stöds.

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]

Exempel

Uppdatera ett mongo-klusters beräkningsnivå.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

Egenskap	Värde
Parametergrupp:	Generic Update Arguments

--admin-password --password -p

Administratörslösenordet. Om värdet är tomt efterfrågas det från tty.tty.

Egenskap	Värde
Parametergrupp:	Administrator Arguments

--admin-user -u

Administratörens användarnamn.

Egenskap	Värde
Parametergrupp:	Administrator Arguments

--auth-allowed-modes

Egenskap	Värde
Parametergrupp:	AuthConfig Arguments

--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--cluster-name --name -n

Namnet på mongo-klustret.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--data-api-mode

Aktivera eller inaktivera Mongo-data-API:et i klustret. Tillåtna värden: Aktiverad, Inaktiverad. Exempel: --data-api-mode Aktiverat.

Egenskap	Värde
Parametergrupp:	DataApi Arguments
Godkända värden:	Disabled, Enabled

--encryption

Krypteringskonfigurationen för klustret. Beror på vilken identitet som har konfigurerats. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

Egenskap	Värde
Parametergrupp:	Generic Update Arguments
Godkända värden:	0, 1, f, false, n, no, t, true, y, yes

--high-availability

Det målläge för hög tillgänglighet som begärs för klustret.

Egenskap	Värde
Parametergrupp:	HighAvailability Arguments
Godkända värden:	Disabled, SameZone, ZoneRedundantPreferred

--ids

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--network-bypass-mode

Nätverksbypass-läget för klustret. Att ställa in på 'AzureCosmosDB' tillåter Azure Cosmos DB-tjänst att kringgå nätverksbegränsningar.

Egenskap	Värde
Parametergrupp:	Properties Arguments
Godkända värden:	AzureCosmosDB, None

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap	Värde
Godkända värden:	0, 1, f, false, n, no, t, true, y, yes

--preview-features

Egenskap	Värde
Parametergrupp:	Properties Arguments

--public-network-access

Om offentlig slutpunktsåtkomst tillåts för det här mongo-klustret eller inte.

Egenskap	Värde
Parametergrupp:	Properties Arguments
Godkända värden:	Disabled, Enabled

--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

Egenskap	Värde
Parametergrupp:	Generic Update Arguments

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--server-version

Mongo DB-serverversionen. Standardvärdet är den senaste tillgängliga versionen om den inte har angetts.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

Egenskap	Värde
Parametergrupp:	Generic Update Arguments

--shard-count

Antal shards som ska etableras i klustret.

Egenskap	Värde
Parametergrupp:	Sharding Arguments

--storage-size

Storleken på den datadisk som tilldelats till varje server.

Egenskap	Värde
Parametergrupp:	Storage Arguments

--storage-type

Den typ av lagring som klusterservrarna ska etableras med.

Egenskap	Värde
Parametergrupp:	Storage Arguments
Godkända värden:	PremiumSSD, PremiumSSDv2

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--tags

Resursetiketter. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap	Värde
Parametergrupp:	Resource Arguments

--tier

Beräkningsnivån som ska tilldelas till klustret, där varje nivå mappas till en virtuell kärna och minnesstorlek. Exempelvärden: "M30", "M40".

Egenskap	Värde
Parametergrupp:	Compute Arguments

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

az documentdb mongocluster wait

Förhandsversion

Kommandogruppen "az documentdb mongocluster" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Placera CLI i vänteläge tills ett villkor uppfylls.

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

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap	Värde
Parametergrupp:	Global Policy Arguments

--cluster-name --name -n

Namnet på mongo-klustret.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments
Standardvärde:	False

--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments

--deleted

Vänta tills den har tagits bort.

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments
Standardvärde:	False

--exists

Vänta tills resursen finns.

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments
Standardvärde:	False

--ids

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--interval

Avsökningsintervall i sekunder.

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments
Standardvärde:	30

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--timeout

Maximal väntetid i sekunder.

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments
Standardvärde:	3600

--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments
Standardvärde:	False

Globala parametrar

--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap	Värde
Standardvärde:	False

Feedback

Var den här sidan till hjälp?