az documentdb mongocluster microsoft-entra-user

  • Preview

Note

This reference is part of the documentdb extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az documentdb mongocluster microsoft-entra-user command. Learn more about extensions.

Command group 'az documentdb mongocluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Microsoft Entra ID users on a mongo cluster.

Commands

Name Description Type Status
az documentdb mongocluster microsoft-entra-user assign

Grant a Microsoft Entra ID principal access to a mongo cluster by assigning it database roles.

 Extension Preview
az documentdb mongocluster microsoft-entra-user list

List the Microsoft Entra ID users on a mongo cluster.

 Extension Preview
az documentdb mongocluster microsoft-entra-user remove

Remove a Microsoft Entra ID principal's access from a mongo cluster.

 Extension Preview
az documentdb mongocluster microsoft-entra-user show

Get the definition of a Microsoft Entra ID user on a mongo cluster.

 Extension Preview
az documentdb mongocluster microsoft-entra-user wait

Place the CLI in a waiting state until a condition is met.

 Extension Preview

az documentdb mongocluster microsoft-entra-user assign

Preview

Command group 'az documentdb mongocluster microsoft-entra-user' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Grant a Microsoft Entra ID principal access to a mongo cluster by assigning it database roles.

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

Examples

Assign admin access to an Entra ID user (or service principal) by object ID.

az documentdb mongocluster microsoft-entra-user assign --object-id 11111111-1111-1111-1111-111111111111 --cluster-name MyCluster -g MyResourceGroup --type User --role db=admin role=root

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-name

The name of the mongo cluster.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --object-id -n

Object ID (client ID) of the Microsoft Entra principal. Provide the GUID of the service principal or user, not a friendly name or UPN.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--role --roles

Database roles that are assigned to the user. Usage: --role db=admin role=root. Multiple roles can be specified by using more than one --role argument. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --role.

Property Value
Parameter group: Properties Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--type -t

The Microsoft Entra principal type of the user. Allowed values: User, ServicePrincipal. Example: --type User.

Property Value
Parameter group: Properties Arguments
Accepted values: ServicePrincipal, User
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az documentdb mongocluster microsoft-entra-user list

Preview

Command group 'az documentdb mongocluster microsoft-entra-user' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the Microsoft Entra ID users on a mongo cluster.

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

Examples

List Entra ID users on a cluster.

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

Required Parameters

--cluster-name

The name of the mongo cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az documentdb mongocluster microsoft-entra-user remove

Preview

Command group 'az documentdb mongocluster microsoft-entra-user' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove a Microsoft Entra ID principal's access from a mongo cluster.

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

Examples

Remove an Entra ID user's access by object ID.

az documentdb mongocluster microsoft-entra-user remove --object-id 11111111-1111-1111-1111-111111111111 --cluster-name MyCluster -g MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-name

The name of the mongo cluster.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --object-id -n

Object ID (client ID) of the Microsoft Entra principal. Provide the GUID of the service principal or user, not a friendly name or UPN.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az documentdb mongocluster microsoft-entra-user show

Preview

Command group 'az documentdb mongocluster microsoft-entra-user' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the definition of a Microsoft Entra ID user on a mongo cluster.

az documentdb mongocluster microsoft-entra-user show [--cluster-name]
                                                     [--ids]
                                                     [--name --object-id]
                                                     [--resource-group]
                                                     [--subscription]

Examples

Get an Entra ID user by object ID.

az documentdb mongocluster microsoft-entra-user show --object-id 11111111-1111-1111-1111-111111111111 --cluster-name MyCluster -g MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

The name of the mongo cluster.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --object-id -n

Object ID (client ID) of the Microsoft Entra principal. Provide the GUID of the service principal or user, not a friendly name or UPN.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az documentdb mongocluster microsoft-entra-user wait

Preview

Command group 'az documentdb mongocluster microsoft-entra-user' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cluster-name

The name of the mongo cluster.

Property Value
Parameter group: Resource Id Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --object-id -n

Object ID (client ID) of the Microsoft Entra principal. Provide the GUID of the service principal or user, not a friendly name or UPN.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False