az documentdb mongocluster firewall-rule

  • Vista previa

Note

Esta referencia forma parte de la extensión documentdb para el CLI de Azure (versión 2.75.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az documentdb mongocluster firewall-rule . Obtenga más información sobre las extensiones.

El grupo de comandos "az documentdb mongocluster" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Administrar regla de firewall.

Comandos

Nombre Description Tipo Estado
az documentdb mongocluster firewall-rule create

Cree una nueva regla de firewall o actualice una regla de firewall existente en un clúster de Mongo.

 Extension Preview
az documentdb mongocluster firewall-rule delete

Elimine una regla de firewall de clúster de Mongo.

 Extension Preview
az documentdb mongocluster firewall-rule list

Enumere todas las reglas de firewall de un clúster de Mongo determinado.

 Extension Preview
az documentdb mongocluster firewall-rule show

Obtenga información sobre una regla de firewall de clúster de Mongo.

 Extension Preview
az documentdb mongocluster firewall-rule update

Actualice una nueva regla de firewall o actualice una regla de firewall existente en un clúster de Mongo.

 Extension Preview
az documentdb mongocluster firewall-rule wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición.

 Extension Preview

az documentdb mongocluster firewall-rule create

Vista previa

El grupo de comandos "az documentdb mongocluster firewall-rule" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Cree una nueva regla de firewall o actualice una regla de firewall existente en un clúster de Mongo.

az documentdb mongocluster firewall-rule create --cluster-name
                                                --firewall-rule-name --name
                                                --resource-group
                                                [--acquire-policy-token]
                                                [--change-reference]
                                                [--end-ip-address]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--start-ip-address]

Ejemplos

Cree una regla de firewall.

az documentdb mongocluster firewall-rule create -n AllowOffice --cluster-name MyCluster -g MyResourceGroup --start-ip-address 1.2.3.4 --end-ip-address 1.2.3.9

Parámetros requeridos

--cluster-name

Nombre del clúster de mongo.

--firewall-rule-name --name -n

Nombre de la regla de firewall del clúster de mongo.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--acquire-policy-token

Adquirir un token de Azure Policy automáticamente para esta operación de recursos.

Propiedad Valor
Grupo de parámetros: Global Policy Arguments
--change-reference

Identificador de referencia de cambio relacionado para esta operación de recurso.

Propiedad Valor
Grupo de parámetros: Global Policy Arguments
--end-ip-address

Dirección IP final de la regla de firewall del clúster de Mongo. Debe tener el formato IPv4.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad Valor
Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--start-ip-address

Dirección IP inicial de la regla de firewall del clúster de mongo. Debe tener el formato IPv4.

Propiedad Valor
Grupo de parámetros: Properties Arguments
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az documentdb mongocluster firewall-rule delete

Vista previa

El grupo de comandos "az documentdb mongocluster firewall-rule" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Elimine una regla de firewall de clúster de Mongo.

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

Ejemplos

Elimine una regla de firewall.

az documentdb mongocluster firewall-rule delete -n AllowOffice --cluster-name MyCluster -g MyResourceGroup

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--acquire-policy-token

Adquirir un token de Azure Policy automáticamente para esta operación de recursos.

Propiedad Valor
Grupo de parámetros: Global Policy Arguments
--change-reference

Identificador de referencia de cambio relacionado para esta operación de recurso.

Propiedad Valor
Grupo de parámetros: Global Policy Arguments
--cluster-name

Nombre del clúster de mongo.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--firewall-rule-name --name -n

Nombre de la regla de firewall del clúster de mongo.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad Valor
Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--yes -y

No solicitar confirmación.

Propiedad Valor
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az documentdb mongocluster firewall-rule list

Vista previa

El grupo de comandos "az documentdb mongocluster firewall-rule" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Enumere todas las reglas de firewall de un clúster de Mongo determinado.

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

Ejemplos

Enumera las reglas de firewall en un clúster.

az documentdb mongocluster firewall-rule list --cluster-name MyCluster -g MyResourceGroup

Parámetros requeridos

--cluster-name

Nombre del clúster de mongo.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--max-items

Número total de elementos que se van a devolver en la salida del comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un token en la salida del comando. Para reanudar la paginación, proporcione el valor del token en --next-token argumento de un comando posterior.

Propiedad Valor
Grupo de parámetros: Pagination Arguments
--next-token

Token para especificar dónde iniciar la paginación. Este es el valor del token de una respuesta truncada anteriormente.

Propiedad Valor
Grupo de parámetros: Pagination Arguments
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az documentdb mongocluster firewall-rule show

Vista previa

El grupo de comandos "az documentdb mongocluster firewall-rule" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Obtenga información sobre una regla de firewall de clúster de Mongo.

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

Ejemplos

Obtenga una regla de firewall.

az documentdb mongocluster firewall-rule show -n AllowOffice --cluster-name MyCluster -g MyResourceGroup

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--cluster-name

Nombre del clúster de mongo.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--firewall-rule-name --name -n

Nombre de la regla de firewall del clúster de mongo.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az documentdb mongocluster firewall-rule update

Vista previa

El grupo de comandos "az documentdb mongocluster firewall-rule" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Actualice una nueva regla de firewall o actualice una regla de firewall existente en un clúster de Mongo.

az documentdb mongocluster firewall-rule update [--acquire-policy-token]
                                                [--add]
                                                [--change-reference]
                                                [--cluster-name]
                                                [--end-ip-address]
                                                [--firewall-rule-name --name]
                                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--ids]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--remove]
                                                [--resource-group]
                                                [--set]
                                                [--start-ip-address]
                                                [--subscription]

Ejemplos

Actualice el intervalo IP de una regla de firewall.

az documentdb mongocluster firewall-rule update -n AllowOffice --cluster-name MyCluster -g MyResourceGroup --end-ip-address 1.2.3.20

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--acquire-policy-token

Adquirir un token de Azure Policy automáticamente para esta operación de recursos.

Propiedad Valor
Grupo de parámetros: Global Policy Arguments
--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.

Propiedad Valor
Grupo de parámetros: Generic Update Arguments
--change-reference

Identificador de referencia de cambio relacionado para esta operación de recurso.

Propiedad Valor
Grupo de parámetros: Global Policy Arguments
--cluster-name

Nombre del clúster de mongo.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--end-ip-address

Dirección IP final de la regla de firewall del clúster de Mongo. Debe tener el formato IPv4.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--firewall-rule-name --name -n

Nombre de la regla de firewall del clúster de mongo.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

Propiedad Valor
Grupo de parámetros: Generic Update Arguments
Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad Valor
Valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Propiedad Valor
Grupo de parámetros: Generic Update Arguments
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.

Propiedad Valor
Grupo de parámetros: Generic Update Arguments
--start-ip-address

Dirección IP inicial de la regla de firewall del clúster de mongo. Debe tener el formato IPv4.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az documentdb mongocluster firewall-rule wait

Vista previa

El grupo de comandos "az documentdb mongocluster firewall-rule" está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Coloque la CLI en un estado de espera hasta que se cumpla una condición.

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--acquire-policy-token

Adquirir un token de Azure Policy automáticamente para esta operación de recursos.

Propiedad Valor
Grupo de parámetros: Global Policy Arguments
--change-reference

Identificador de referencia de cambio relacionado para esta operación de recurso.

Propiedad Valor
Grupo de parámetros: Global Policy Arguments
--cluster-name

Nombre del clúster de mongo.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
--deleted

Espere hasta que se elimine.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
--exists

Espere hasta que exista el recurso.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
--firewall-rule-name --name -n

Nombre de la regla de firewall del clúster de mongo.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--interval

Intervalo de sondeo en segundos.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: 30
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--timeout

Espera máxima en segundos.

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

Propiedad Valor
Grupo de parámetros: Wait Condition Arguments
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False