az documentdb mongocluster user

Note

Questo riferimento fa parte dell'estensione documentdb per il interfaccia della riga di comando di Azure (versione 2.75.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az documentdb mongocluster user . Altre informazioni sulle estensioni.

Gestisci utente.

Comandi

Nome	Descrizione	Tipo	Status
az documentdb mongocluster user create	Creare un nuovo utente o aggiornare un utente esistente in un cluster mongo.	Extension	GA
az documentdb mongocluster user delete	Eliminare un utente del cluster mongo.	Extension	GA
az documentdb mongocluster user list	Elencare tutti gli utenti in un cluster mongo.	Extension	GA
az documentdb mongocluster user show	Ottenere la definizione di un utente del cluster Mongo.	Extension	GA
az documentdb mongocluster user update	Aggiornare un nuovo utente o aggiornare un utente esistente in un cluster mongo.	Extension	GA
az documentdb mongocluster user wait	Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione.	Extension	GA

az documentdb mongocluster user create

Creare un nuovo utente o aggiornare un utente esistente in un cluster mongo.

az documentdb mongocluster user create --cluster-name
                                       --name --user-name
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--role --roles]
                                       [--type {ServicePrincipal, User}]

Esempio

Creare un utente supportato da Entra.

az documentdb mongocluster user create -n alice-entra --cluster-name MyCluster -g MyResourceGroup --type User --role db=admin role=root

Parametri necessari

--cluster-name

Nome del cluster mongo.

--name --user-name -n

Nome dell'utente del cluster mongo.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà	Valore
Gruppo di parametri:	Global Policy Arguments

--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà	Valore
Gruppo di parametri:	Global Policy Arguments

--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Proprietà	Valore
Valori accettati:	0, 1, f, false, n, no, t, true, y, yes

--role --roles

Ruoli del database assegnati all'utente. Utilizzo: --role db=admin role=root. È possibile specificare più ruoli usando più di un argomento --role. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più. Flag singolari: --role.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--type -t

Il Microsoft Entra tipo di entità dell'utente. Valori consentiti: User, ServicePrincipal. Esempio: --type User.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments
Valori accettati:	ServicePrincipal, User

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà	Valore
Valore predefinito:	False

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà	Valore
Valore predefinito:	False

--output -o

Formato dell'output.

Proprietà	Valore
Valore predefinito:	json
Valori accettati:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà	Valore
Valore predefinito:	False

az documentdb mongocluster user delete

Eliminare un utente del cluster mongo.

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

Esempio

Eliminare un utente.

az documentdb mongocluster user delete -n alice@contoso.com --cluster-name MyCluster -g MyResourceGroup

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà	Valore
Gruppo di parametri:	Global Policy Arguments

--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà	Valore
Gruppo di parametri:	Global Policy Arguments

--cluster-name

Nome del cluster mongo.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--name --user-name -n

Nome dell'utente del cluster mongo.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Proprietà	Valore
Valori accettati:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--yes -y

Non richiedere conferma.

Proprietà	Valore
Valore predefinito:	False

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà	Valore
Valore predefinito:	False

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà	Valore
Valore predefinito:	False

--output -o

Formato dell'output.

Proprietà	Valore
Valore predefinito:	json
Valori accettati:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà	Valore
Valore predefinito:	False

az documentdb mongocluster user list

Elencare tutti gli utenti in un cluster mongo.

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

Esempio

Elencare gli utenti in un cluster.

az documentdb mongocluster user list --cluster-name MyCluster -g MyResourceGroup

Parametri necessari

--cluster-name

Nome del cluster mongo.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--max-items

Numero totale di elementi da restituire nell'output del comando. Se il numero totale di elementi disponibili è maggiore del valore specificato, nell'output del comando viene fornito un token. Per riprendere la paginazione, specificare il valore del token in --next-token argomento di un comando successivo.

Proprietà	Valore
Gruppo di parametri:	Pagination Arguments

--next-token

Token per specificare dove iniziare la paginazione. Si tratta del valore del token di una risposta troncata in precedenza.

Proprietà	Valore
Gruppo di parametri:	Pagination Arguments

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà	Valore
Valore predefinito:	False

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà	Valore
Valore predefinito:	False

--output -o

Formato dell'output.

Proprietà	Valore
Valore predefinito:	json
Valori accettati:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà	Valore
Valore predefinito:	False

az documentdb mongocluster user show

Ottenere la definizione di un utente del cluster Mongo.

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

Esempio

Ottenere un utente.

az documentdb mongocluster user show -n alice@contoso.com --cluster-name MyCluster -g MyResourceGroup

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--cluster-name

Nome del cluster mongo.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--name --user-name -n

Nome dell'utente del cluster mongo.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà	Valore
Valore predefinito:	False

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà	Valore
Valore predefinito:	False

--output -o

Formato dell'output.

Proprietà	Valore
Valore predefinito:	json
Valori accettati:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà	Valore
Valore predefinito:	False

az documentdb mongocluster user update

Aggiornare un nuovo utente o aggiornare un utente esistente in un cluster mongo.

az documentdb mongocluster user update [--acquire-policy-token]
                                       [--add]
                                       [--change-reference]
                                       [--cluster-name]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--name --user-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--remove]
                                       [--resource-group]
                                       [--role --roles]
                                       [--set]
                                       [--subscription]
                                       [--type {ServicePrincipal, User}]

Esempio

Aggiornare i ruoli di un utente.

az documentdb mongocluster user update -n alice-entra --cluster-name MyCluster -g MyResourceGroup --role db=admin role=root

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà	Valore
Gruppo di parametri:	Global Policy Arguments

--add

Aggiungere un oggetto a un elenco di oggetti specificando un percorso e coppie chiave-valore. Esempio: --add property.listProperty <key=value, string or JSON string>.

Proprietà	Valore
Gruppo di parametri:	Generic Update Arguments

--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà	Valore
Gruppo di parametri:	Global Policy Arguments

--cluster-name

Nome del cluster mongo.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--force-string

Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.

Proprietà	Valore
Gruppo di parametri:	Generic Update Arguments
Valori accettati:	0, 1, f, false, n, no, t, true, y, yes

--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--name --user-name -n

Nome dell'utente del cluster mongo.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Proprietà	Valore
Valori accettati:	0, 1, f, false, n, no, t, true, y, yes

--remove

Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Proprietà	Valore
Gruppo di parametri:	Generic Update Arguments

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--role --roles

Ruoli del database assegnati all'utente. Utilizzo: --role db=admin role=root. È possibile specificare più ruoli usando più di un argomento --role. Supportare la sintassi abbreviata, json-file e yaml-file. Prova "??" per mostrare di più. Flag singolari: --role.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments

--set

Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=<value>.

Proprietà	Valore
Gruppo di parametri:	Generic Update Arguments

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--type -t

Il Microsoft Entra tipo di entità dell'utente. Valori consentiti: User, ServicePrincipal. Esempio: --type User.

Proprietà	Valore
Gruppo di parametri:	Properties Arguments
Valori accettati:	ServicePrincipal, User

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà	Valore
Valore predefinito:	False

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà	Valore
Valore predefinito:	False

--output -o

Formato dell'output.

Proprietà	Valore
Valore predefinito:	json
Valori accettati:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà	Valore
Valore predefinito:	False

az documentdb mongocluster user wait

Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione.

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

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà	Valore
Gruppo di parametri:	Global Policy Arguments

--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà	Valore
Gruppo di parametri:	Global Policy Arguments

--cluster-name

Nome del cluster mongo.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--created

Attendere fino a quando non viene creato con 'provisioningState' in 'Succeeded'.

Proprietà	Valore
Gruppo di parametri:	Wait Condition Arguments
Valore predefinito:	False

--custom

Attendere che la condizione soddisfi una query JMESPath personalizzata. Ad esempio provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Proprietà	Valore
Gruppo di parametri:	Wait Condition Arguments

--deleted

Attendere l'eliminazione.

Proprietà	Valore
Gruppo di parametri:	Wait Condition Arguments
Valore predefinito:	False

--exists

Attendere che la risorsa esista.

Proprietà	Valore
Gruppo di parametri:	Wait Condition Arguments
Valore predefinito:	False

--ids

Uno o più ID risorsa (delimitati da spazi). Deve essere un ID risorsa completo contenente tutte le informazioni degli argomenti "ID risorsa". È necessario specificare --ids o altri argomenti "ID risorsa".

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--interval

Intervallo di polling in secondi.

Proprietà	Valore
Gruppo di parametri:	Wait Condition Arguments
Valore predefinito:	30

--name --user-name -n

Nome dell'utente del cluster mongo.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

Proprietà	Valore
Gruppo di parametri:	Resource Id Arguments

--timeout

Attesa massima in secondi.

Proprietà	Valore
Gruppo di parametri:	Wait Condition Arguments
Valore predefinito:	3600

--updated

Attendere fino a quando non viene aggiornato con provisioningState in 'Succeeded'.

Proprietà	Valore
Gruppo di parametri:	Wait Condition Arguments
Valore predefinito:	False

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà	Valore
Valore predefinito:	False

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà	Valore
Valore predefinito:	False

--output -o

Formato dell'output.

Proprietà	Valore
Valore predefinito:	json
Valori accettati:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà	Valore
Valore predefinito:	False