az documentdb mongocluster

  • Preview uitvoeren

Opmerking

Deze verwijzing maakt deel uit van de documentdb-extensie voor de Azure CLI (versie 2.75.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az documentdb mongocluster-opdracht uitvoert. Meer informatie over uitbreidingen.

Opdrachtgroep 'az documentdb' is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Beheer Azure DocumentDB Mongo-clusters.

Opdracht

Naam Description Type Status
az documentdb mongocluster check-name-availability

Controleer of de mongo-clusternaam beschikbaar is voor gebruik.

 Extension Preview
az documentdb mongocluster create

Maak een Mongo-cluster. Bijwerken overschrijft alle eigenschappen voor de resource. Als u slechts enkele eigenschappen wilt wijzigen, gebruikt u PATCH.

 Extension Preview
az documentdb mongocluster delete

Een Mongo-cluster verwijderen.

 Extension Preview
az documentdb mongocluster firewall-rule

Firewallregel beheren.

 Extension Preview
az documentdb mongocluster firewall-rule create

Maak een nieuwe firewallregel of werk een bestaande firewallregel bij op een Mongo-cluster.

 Extension Preview
az documentdb mongocluster firewall-rule delete

Verwijder een mongo-clusterfirewallregel.

 Extension Preview
az documentdb mongocluster firewall-rule list

Vermeld alle firewallregels in een bepaald Mongo-cluster.

 Extension Preview
az documentdb mongocluster firewall-rule show

Informatie ophalen over een mongo-clusterfirewallregel.

 Extension Preview
az documentdb mongocluster firewall-rule update

Werk een nieuwe firewallregel bij of werkt een bestaande firewallregel bij op een Mongo-cluster.

 Extension Preview
az documentdb mongocluster firewall-rule wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde is voldaan.

 Extension Preview
az documentdb mongocluster identity

Identiteit beheren.

 Extension Preview
az documentdb mongocluster identity assign

Wijs de door de gebruiker of het systeem beheerde identiteiten toe.

 Extension Preview
az documentdb mongocluster identity list

Vermeld de beheerde identiteiten die zijn toegewezen aan een Mongo-cluster.

 Extension Preview
az documentdb mongocluster identity remove

Verwijder de door de gebruiker of het systeem beheerde identiteiten.

 Extension Preview
az documentdb mongocluster identity show

De details van beheerde identiteiten weergeven.

 Extension Preview
az documentdb mongocluster identity wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde is voldaan.

 Extension Preview
az documentdb mongocluster list

Vermeld alle Mongo-clusters in een bepaald abonnement.

 Extension Preview
az documentdb mongocluster list-connection-strings

Maak een lijst met mongo-clusterverbindingsreeksen. Dit omvat de standaardverbindingsreeks met SCRAM-SHA-256, evenals andere verbindingsreeksen die door het cluster worden ondersteund.

 Extension Preview
az documentdb mongocluster microsoft-entra-user

Beheer Microsoft Entra ID gebruikers in een Mongo-cluster.

 Extension Preview
az documentdb mongocluster microsoft-entra-user assign

Verwijs een Microsoft Entra ID principal toegang tot een Mongo-cluster door deze databaserollen toe te wijzen.

 Extension Preview
az documentdb mongocluster microsoft-entra-user list

Vermeld de Microsoft Entra ID gebruikers in een Mongo-cluster.

 Extension Preview
az documentdb mongocluster microsoft-entra-user remove

Verwijder de toegang van een Microsoft Entra ID principal uit een Mongo-cluster.

 Extension Preview
az documentdb mongocluster microsoft-entra-user show

Haal de definitie van een Microsoft Entra ID gebruiker op in een Mongo-cluster.

 Extension Preview
az documentdb mongocluster microsoft-entra-user wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde is voldaan.

 Extension Preview
az documentdb mongocluster replica

Replica beheren.

 Extension Preview
az documentdb mongocluster replica create

Maak een leesreplica van een bestaand Mongo-cluster.

 Extension Preview
az documentdb mongocluster replica list

Geef alle replica's voor het Mongo-cluster weer.

 Extension Preview
az documentdb mongocluster replica promote

Bevordert een replica mongo-cluster naar een primaire rol.

 Extension Preview
az documentdb mongocluster reset-password

Stel het beheerderswachtwoord van een Mongo-cluster opnieuw in.

 Extension Preview
az documentdb mongocluster restore

Herstel een Mongo-cluster naar een nieuw cluster vanaf een bepaald tijdstip.

 Extension Preview
az documentdb mongocluster show

Informatie ophalen over een Mongo-cluster.

 Extension Preview
az documentdb mongocluster update

Een Mongo-cluster bijwerken. Alleen de eigenschappen die in de aanvraag zijn opgegeven, worden gewijzigd; alle andere eigenschappen blijven ongewijzigd (HTTP PATCH). Algemene updateargumenten (--set, --add, --remove) worden ondersteund.

 Extension Preview
az documentdb mongocluster wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde is voldaan.

 Extension Preview

az documentdb mongocluster check-name-availability

Preview uitvoeren

Opdrachtgroep az documentdb mongocluster is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Controleer of de mongo-clusternaam beschikbaar is voor gebruik.

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

Voorbeelden

Controleer of er een mongo-clusternaam beschikbaar is.

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

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--location -l

Location. Waarden van: az account list-locations. U kunt de standaardlocatie configureren met behulp van az configure --defaults location=<location>.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--name

De naam van de resource waarvoor de beschikbaarheid moet worden gecontroleerd.

Eigenschap Waarde
Parametergroep: Body Arguments
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--type

Het hulpbrontype.

Eigenschap Waarde
Parametergroep: Body Arguments
Default value: Microsoft.DocumentDB/mongoClusters
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az documentdb mongocluster create

Preview uitvoeren

Opdrachtgroep az documentdb mongocluster is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Maak een Mongo-cluster. Bijwerken overschrijft alle eigenschappen voor de resource. Als u slechts enkele eigenschappen wilt wijzigen, gebruikt u 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]

Voorbeelden

Maak een Mongo-cluster met Premium SSD v2-opslag.

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

Vereiste parameters

--admin-password --password -p

Het beheerderswachtwoord. Als de waarde leeg is, wordt deze door de tty gevraagd.

Eigenschap Waarde
Parametergroep: Administrator Arguments
--admin-user -u

De gebruikersnaam van de beheerder.

Eigenschap Waarde
Parametergroep: Administrator Arguments
--cluster-name --name -n

De naam van het Mongo-cluster.

--high-availability

De doelmodus voor hoge beschikbaarheid die is aangevraagd voor het cluster.

Eigenschap Waarde
Parametergroep: HighAvailability Arguments
Geaccepteerde waarden: Disabled, SameZone, ZoneRedundantPreferred
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--shard-count

Aantal shards dat moet worden ingericht op het cluster.

Eigenschap Waarde
Parametergroep: Sharding Arguments
--storage-size

De grootte van de gegevensschijf die aan elke server is toegewezen.

Eigenschap Waarde
Parametergroep: Storage Arguments
--tier

De rekenlaag die moet worden toegewezen aan het cluster, waarbij elke laag wordt toegewezen aan een virtuele kern en geheugengrootte. Voorbeeldwaarden: 'M30', 'M40'.

Eigenschap Waarde
Parametergroep: Compute Arguments

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--auth-allowed-modes

Door ruimte gescheiden lijst met toegestane verificatiemodi voor gegevenstoegang. Toegestane waarden: NativeAuth, MicrosoftEntraID. Voorbeeld: --auth-allowed-modes NativeAuth MicrosoftEntraID Support shorthand-syntax, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: AuthConfig Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--data-api-mode

Schakel de Mongo Data-API in of uit op het cluster. Toegestane waarden: Ingeschakeld, Uitgeschakeld. Voorbeeld: --data-api-mode ingeschakeld.

Eigenschap Waarde
Parametergroep: DataApi Arguments
Geaccepteerde waarden: Disabled, Enabled
--encryption

De versleutelingsconfiguratie voor het cluster. Afhankelijk van de identiteit die wordt geconfigureerd. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: Properties Arguments
--location -l

De geografische locatie waar de resource zich bevindt wanneer deze niet is opgegeven, wordt de locatie van de resourcegroep gebruikt.

Eigenschap Waarde
Parametergroep: Resource Arguments
--mi-user-assigned --user-assigned

Stel de door de gebruiker beheerde identiteiten in. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: Identity Arguments
--network-bypass-mode

De netwerkbypassmodus voor de cluster. Door 'AzureCosmosDB' in te stellen, kan Azure Cosmos DB-service netwerkbeperkingen omzeilen.

Eigenschap Waarde
Parametergroep: Properties Arguments
Geaccepteerde waarden: AzureCosmosDB, None
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--preview-features

Door ruimte gescheiden lijst met preview-functies die u op het cluster wilt inschakelen. Preview-functienamen zijn vrije tekenreeksen; Raadpleeg de documentatie voor mongo-clusterfuncties voor de momenteel beschikbare waarden. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: Properties Arguments
--public-network-access

Of openbare eindpunttoegang wel of niet is toegestaan voor dit Mongo-cluster.

Eigenschap Waarde
Parametergroep: Properties Arguments
Geaccepteerde waarden: Disabled, Enabled
--server-version

De Mongo DB-serverversie. Standaard ingesteld op de meest recente beschikbare versie als deze niet is opgegeven.

Eigenschap Waarde
Parametergroep: Properties Arguments
--storage-type

Het type opslag waarmee de clusterservers moeten worden ingericht.

Eigenschap Waarde
Parametergroep: Storage Arguments
Geaccepteerde waarden: PremiumSSD, PremiumSSDv2
--tags

Resourcetags. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: Resource Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az documentdb mongocluster delete

Preview uitvoeren

Opdrachtgroep az documentdb mongocluster is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Een Mongo-cluster verwijderen.

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]

Voorbeelden

Een Mongo-cluster verwijderen.

az documentdb mongocluster delete -n MyCluster -g MyResourceGroup

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--cluster-name --name -n

De naam van het Mongo-cluster.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--yes -y

Niet vragen om bevestiging.

Eigenschap Waarde
Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az documentdb mongocluster list

Preview uitvoeren

Opdrachtgroep az documentdb mongocluster is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Vermeld alle Mongo-clusters in een bepaald abonnement.

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

Voorbeelden

Alle Mongo-clusters in een resourcegroep weergeven.

az documentdb mongocluster list -g MyResourceGroup

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--max-items

Totaal aantal items dat moet worden geretourneerd in de uitvoer van de opdracht. Als het totale aantal beschikbare items groter is dan de opgegeven waarde, wordt een token opgegeven in de uitvoer van de opdracht. Als u paginering wilt hervatten, geeft u de tokenwaarde op in --next-token argument van een volgende opdracht.

Eigenschap Waarde
Parametergroep: Pagination Arguments
--next-token

Token om op te geven waar paginering moet worden gestart. Dit is de tokenwaarde van een eerder afgekapt antwoord.

Eigenschap Waarde
Parametergroep: Pagination Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az documentdb mongocluster list-connection-strings

Preview uitvoeren

Opdrachtgroep az documentdb mongocluster is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Maak een lijst met mongo-clusterverbindingsreeksen. Dit omvat de standaardverbindingsreeks met SCRAM-SHA-256, evenals andere verbindingsreeksen die door het cluster worden ondersteund.

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

Voorbeelden

Geef de verbindingsreeksen voor een Mongo-cluster weer.

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

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--cluster-name

De naam van het Mongo-cluster.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az documentdb mongocluster reset-password

Preview uitvoeren

Opdrachtgroep az documentdb mongocluster is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Stel het beheerderswachtwoord van een Mongo-cluster opnieuw in.

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]

Voorbeelden

Stel het beheerderswachtwoord opnieuw in.

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

Vereiste parameters

--admin-password --password -p

Het nieuwe beheerderswachtwoord. Als de waarde leeg is, wordt deze door de tty gevraagd.

Eigenschap Waarde
Parametergroep: Administrator Arguments

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--cluster-name --name -n

De naam van het Mongo-cluster.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az documentdb mongocluster restore

Preview uitvoeren

Opdrachtgroep az documentdb mongocluster is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Herstel een Mongo-cluster naar een nieuw cluster vanaf een bepaald tijdstip.

Hiermee maakt u een nieuw Mongo-cluster op basis van de back-up van een bestaand (of verwijderd) broncluster op het aangevraagde tijdstip.

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

Voorbeelden

Herstel een cluster naar een bepaald tijdstip.

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!

Vereiste parameters

--admin-password --password -p

Het beheerderswachtwoord. Als de waarde leeg is, wordt deze door de tty gevraagd.

Eigenschap Waarde
Parametergroep: Administrator Arguments
--admin-user -u

De gebruikersnaam van de beheerder.

Eigenschap Waarde
Parametergroep: Administrator Arguments
--cluster-name --name -n

De naam van het Mongo-cluster.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--restore-time

UTC-tijdstip om te herstellen, in ISO-8601-indeling (bijvoorbeeld: 2026-06-30T10:00:00Z).

Eigenschap Waarde
Parametergroep: Restore Arguments
--source-cluster

Naam of resource-id van het mongo-broncluster waaruit u wilt herstellen. Als er een naam wordt opgegeven, worden het huidige abonnement en de resourcegroep ervan uitgegaan.

Eigenschap Waarde
Parametergroep: Restore Arguments

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--location -l

De geografische locatie waar de resource zich bevindt wanneer deze niet is opgegeven, wordt de locatie van de resourcegroep gebruikt.

Eigenschap Waarde
Parametergroep: Resource Arguments
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az documentdb mongocluster show

Preview uitvoeren

Opdrachtgroep az documentdb mongocluster is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Informatie ophalen over een Mongo-cluster.

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

Voorbeelden

Informatie ophalen over een Mongo-cluster.

az documentdb mongocluster show -n MyCluster -g MyResourceGroup

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--cluster-name --name -n

De naam van het Mongo-cluster.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az documentdb mongocluster update

Preview uitvoeren

Opdrachtgroep az documentdb mongocluster is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Een Mongo-cluster bijwerken. Alleen de eigenschappen die in de aanvraag zijn opgegeven, worden gewijzigd; alle andere eigenschappen blijven ongewijzigd (HTTP PATCH). Algemene updateargumenten (--set, --add, --remove) worden ondersteund.

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]

Voorbeelden

Werk de rekenlaag van een Mongo-cluster bij.

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

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string or JSON string>.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
--admin-password --password -p

Het beheerderswachtwoord. Als de waarde leeg is, wordt deze door de tty gevraagd.

Eigenschap Waarde
Parametergroep: Administrator Arguments
--admin-user -u

De gebruikersnaam van de beheerder.

Eigenschap Waarde
Parametergroep: Administrator Arguments
--auth-allowed-modes

Door ruimte gescheiden lijst met toegestane verificatiemodi voor gegevenstoegang. Toegestane waarden: NativeAuth, MicrosoftEntraID. Voorbeeld: --auth-allowed-modes NativeAuth MicrosoftEntraID Support shorthand-syntax, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: AuthConfig Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--cluster-name --name -n

De naam van het Mongo-cluster.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--data-api-mode

Schakel de Mongo Data-API in of uit op het cluster. Toegestane waarden: Ingeschakeld, Uitgeschakeld. Voorbeeld: --data-api-mode ingeschakeld.

Eigenschap Waarde
Parametergroep: DataApi Arguments
Geaccepteerde waarden: Disabled, Enabled
--encryption

De versleutelingsconfiguratie voor het cluster. Afhankelijk van de identiteit die wordt geconfigureerd. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: Properties Arguments
--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--high-availability

De doelmodus voor hoge beschikbaarheid die is aangevraagd voor het cluster.

Eigenschap Waarde
Parametergroep: HighAvailability Arguments
Geaccepteerde waarden: Disabled, SameZone, ZoneRedundantPreferred
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--network-bypass-mode

De netwerkbypassmodus voor de cluster. Door 'AzureCosmosDB' in te stellen, kan Azure Cosmos DB-service netwerkbeperkingen omzeilen.

Eigenschap Waarde
Parametergroep: Properties Arguments
Geaccepteerde waarden: AzureCosmosDB, None
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--preview-features

Door ruimte gescheiden lijst met preview-functies die u op het cluster wilt inschakelen. Preview-functienamen zijn vrije tekenreeksen; Raadpleeg de documentatie voor mongo-clusterfuncties voor de momenteel beschikbare waarden. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: Properties Arguments
--public-network-access

Of openbare eindpunttoegang wel of niet is toegestaan voor dit Mongo-cluster.

Eigenschap Waarde
Parametergroep: Properties Arguments
Geaccepteerde waarden: Disabled, Enabled
--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--server-version

De Mongo DB-serverversie. Standaard ingesteld op de meest recente beschikbare versie als deze niet is opgegeven.

Eigenschap Waarde
Parametergroep: Properties Arguments
--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
--shard-count

Aantal shards dat moet worden ingericht op het cluster.

Eigenschap Waarde
Parametergroep: Sharding Arguments
--storage-size

De grootte van de gegevensschijf die aan elke server is toegewezen.

Eigenschap Waarde
Parametergroep: Storage Arguments
--storage-type

Het type opslag waarmee de clusterservers moeten worden ingericht.

Eigenschap Waarde
Parametergroep: Storage Arguments
Geaccepteerde waarden: PremiumSSD, PremiumSSDv2
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--tags

Resourcetags. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: Resource Arguments
--tier

De rekenlaag die moet worden toegewezen aan het cluster, waarbij elke laag wordt toegewezen aan een virtuele kern en geheugengrootte. Voorbeeldwaarden: 'M30', 'M40'.

Eigenschap Waarde
Parametergroep: Compute Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az documentdb mongocluster wait

Preview uitvoeren

Opdrachtgroep az documentdb mongocluster is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Plaats de CLI in een wachtstatus totdat aan een voorwaarde is voldaan.

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

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--cluster-name --name -n

De naam van het Mongo-cluster.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--created

Wacht totdat u 'provisioningState' hebt gemaakt bij 'Succeeded'.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
--custom

Wacht tot de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
--deleted

Wacht totdat deze is verwijderd.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
--exists

Wacht tot de resource bestaat.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--interval

Polling-interval in seconden.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: 30
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--timeout

Maximale wachttijd in seconden.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: 3600
--updated

Wacht totdat deze is bijgewerkt met provisioningState op 'Succeeded'.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False