Compartir a través de

az cosmosdb service

Note

Este grupo de comandos tiene comandos definidos en la CLI de Azure y al menos una extensión. Instale cada extensión para beneficiarse de sus funcionalidades extendidas. Obtenga más información sobre las extensiones.

Comandos para realizar operaciones en el servicio.

Comandos

Nombre Description Tipo Estado
az cosmosdb service create

Cree un recurso de servicio cosmosdb.

 Core GA
az cosmosdb service create (cosmosdb-preview extensión)

Cree un recurso de servicio cosmosdb.

 Extension Preview
az cosmosdb service delete

Elimine el recurso de servicio cosmosdb especificado.

 Core GA
az cosmosdb service delete (cosmosdb-preview extensión)

Elimine el recurso de servicio cosmosdb especificado.

 Extension Preview
az cosmosdb service list

Enumere todos los recursos del servicio cosmosdb en una cuenta.

 Core GA
az cosmosdb service list (cosmosdb-preview extensión)

Enumere todos los recursos del servicio cosmosdb en una cuenta.

 Extension Preview
az cosmosdb service show

Obtenga el recurso del servicio cosmosdb en una cuenta.

 Core GA
az cosmosdb service show (cosmosdb-preview extensión)

Obtenga el recurso del servicio cosmosdb en una cuenta.

 Extension Preview
az cosmosdb service update

Actualice un recurso de servicio cosmosdb.

 Core GA
az cosmosdb service update (cosmosdb-preview extensión)

Actualice un recurso de servicio cosmosdb.

 Extension Preview

az cosmosdb service create

Editar

Cree un recurso de servicio cosmosdb.

az cosmosdb service create --account-name
                           --name
                           --resource-group-name
                           [--count]
                           [--gateway-type {DistributedQuery, IntegratedCache}]
                           [--no-wait]
                           [--size]

Ejemplos

Cree un recurso de servicio cosmosdb.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --count 3 --size "Cosmos.D4s"

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de Cosmos DB.

--name -n

Nombre del servicio.

--resource-group-name -g

Nombre del grupo de recursos de la cuenta de base de datos.

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.

--count -c

Recuento de instancias.

Propiedad Valor
Valor predeterminado: 1
--gateway-type

Tipo de puerta de enlace dedicada. Válido solo para el tipo de servicio SqlDedicatedGateway.

Propiedad Valor
Valor predeterminado: IntegratedCache
Valores aceptados: DistributedQuery, IntegratedCache
--no-wait

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

Propiedad Valor
Valor predeterminado: False
--size

Tamaño de instancia. Los valores posibles son: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s, etc.

Propiedad Valor
Valor predeterminado: Cosmos.D4s
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 cosmosdb service create (cosmosdb-preview extensión)

Vista previa

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

Cree un recurso de servicio cosmosdb.

az cosmosdb service create --account-name
                           --kind
                           --name
                           --resource-group-name
                           [--count]
                           [--gateway-type {DistributedQuery, IntegratedCache}]
                           [--no-wait]
                           [--size]

Ejemplos

Cree un recurso de servicio cosmosdb.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --kind "SqlDedicatedGateway" --count 3 --size "Cosmos.D4s"

Cree un recurso de servicio de generador de vistas materializadas de cosmosdb.

az cosmosdb service create --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder" --kind "MaterializedViewsBuilder" --count 3 --size "Cosmos.D4s"

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de Cosmos DB.

--kind -k

Tipo de servicio.

--name -n

Nombre del servicio.

--resource-group-name -g

Nombre del grupo de recursos de la cuenta de base de datos.

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.

--count -c

Recuento de instancias.

Propiedad Valor
Valor predeterminado: 1
--gateway-type

Tipo de puerta de enlace dedicada. Válido solo para el tipo de servicio SqlDedicatedGateway.

Propiedad Valor
Valor predeterminado: IntegratedCache
Valores aceptados: DistributedQuery, IntegratedCache
--no-wait

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

Propiedad Valor
Valor predeterminado: False
--size

Tamaño de instancia. Los valores posibles son: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s, etc.

Propiedad Valor
Valor predeterminado: Cosmos.D4s
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 cosmosdb service delete

Editar

Elimine el recurso de servicio cosmosdb especificado.

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--yes]

Ejemplos

Elimine el recurso de servicio cosmosdb especificado.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de Cosmos DB.

--name -n

Nombre del servicio.

--resource-group-name -g

Nombre del grupo de recursos de la cuenta de base de datos.

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.

--no-wait

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

Propiedad Valor
Valor predeterminado: False
--yes -y

No solicita 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.

--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 cosmosdb service delete (cosmosdb-preview extensión)

Vista previa

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

Elimine el recurso de servicio cosmosdb especificado.

az cosmosdb service delete --account-name
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--yes]

Ejemplos

Elimine el recurso de servicio cosmosdb especificado.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Elimine el recurso del servicio del generador de vistas materializadas de cosmosdb.

az cosmosdb service delete --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder"

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de Cosmos DB.

--name -n

Nombre del servicio.

--resource-group-name -g

Nombre del grupo de recursos de la cuenta de base de datos.

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.

--no-wait

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

Propiedad Valor
Valor predeterminado: False
--yes -y

No solicita 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.

--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 cosmosdb service list

Editar

Enumere todos los recursos del servicio cosmosdb en una cuenta.

az cosmosdb service list --account-name
                         --resource-group-name

Ejemplos

Enumere todos los recursos del servicio cosmosdb en una cuenta.

az cosmosdb service list --resource-group MyResourceGroup --account-name MyAccount

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de Cosmos DB.

--resource-group-name -g

Nombre del grupo de recursos de la cuenta de base de datos.

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 cosmosdb service list (cosmosdb-preview extensión)

Vista previa

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

Enumere todos los recursos del servicio cosmosdb en una cuenta.

az cosmosdb service list --account-name
                         --resource-group-name

Ejemplos

Enumere todos los recursos del servicio cosmosdb en una cuenta.

az cosmosdb service list --resource-group MyResourceGroup --account-name MyAccount

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de Cosmos DB.

--resource-group-name -g

Nombre del grupo de recursos de la cuenta de base de datos.

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 cosmosdb service show

Editar

Obtenga el recurso del servicio cosmosdb en una cuenta.

az cosmosdb service show --account-name
                         --name
                         --resource-group-name

Ejemplos

Obtenga el recurso del servicio cosmosdb en una cuenta.

az cosmosdb service show --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de Cosmos DB.

--name -n

Nombre del servicio.

--resource-group-name -g

Nombre del grupo de recursos de la cuenta de base de datos.

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 cosmosdb service show (cosmosdb-preview extensión)

Vista previa

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

Obtenga el recurso del servicio cosmosdb en una cuenta.

az cosmosdb service show --account-name
                         --name
                         --resource-group-name

Ejemplos

Obtenga el recurso del servicio cosmosdb en una cuenta.

az cosmosdb service show --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway"

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de Cosmos DB.

--name -n

Nombre del servicio.

--resource-group-name -g

Nombre del grupo de recursos de la cuenta de base de datos.

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 cosmosdb service update

Editar

Actualice un recurso de servicio cosmosdb.

az cosmosdb service update --account-name
                           --count
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--size]

Ejemplos

Actualice un recurso de servicio cosmosdb.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --count 3

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de Cosmos DB.

--count -c

Recuento de instancias.

--name -n

Nombre del servicio.

--resource-group-name -g

Nombre del grupo de recursos de la cuenta de base de datos.

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.

--no-wait

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

Propiedad Valor
Valor predeterminado: False
--size

Tamaño de instancia. Los valores posibles son: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s, etc.

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 cosmosdb service update (cosmosdb-preview extensión)

Vista previa

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

Actualice un recurso de servicio cosmosdb.

az cosmosdb service update --account-name
                           --count
                           --kind
                           --name
                           --resource-group-name
                           [--no-wait]
                           [--size]

Ejemplos

Actualice un recurso de servicio cosmosdb.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "sqlDedicatedGateway" --kind "SqlDedicatedGateway" --count 3

Actualice un recurso de servicio del generador de vistas materializadas de cosmosdb.

az cosmosdb service update --resource-group MyResourceGroup --account-name MyAccount --name "MaterializedViewsBuilder" --kind "MaterializedViewsBuilder" --count 3

Parámetros requeridos

--account-name -a

Nombre de la cuenta de base de datos de Cosmos DB.

--count -c

Recuento de instancias.

--kind -k

Tipo de servicio.

--name -n

Nombre del servicio.

--resource-group-name -g

Nombre del grupo de recursos de la cuenta de base de datos.

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.

--no-wait

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

Propiedad Valor
Valor predeterminado: False
--size

Tamaño de instancia. Los valores posibles son: Cosmos.D4s, Cosmos.D8s, Cosmos.D16s, etc.

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