Compartir a través de

az spring gateway

  • Referencia

Nota:

Esta referencia forma parte de la extensión spring para la CLI de Azure (versión 2.56.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az spring gateway . Obtenga más información sobre las extensiones.

(Solo nivel De empresa) Comandos para administrar la puerta de enlace en Azure Spring Apps.

Comandos

Nombre Description Tipo Estado
az spring gateway clear

Borre toda la configuración de la puerta de enlace.

 Extensión GA
az spring gateway create

Cree Spring Cloud Gateway.

 Extensión GA
az spring gateway custom-domain

Comandos para administrar dominios personalizados para la puerta de enlace.

 Extensión GA
az spring gateway custom-domain bind

Enlace de un dominio personalizado con la puerta de enlace.

 Extensión GA
az spring gateway custom-domain list

Enumere todos los dominios personalizados de la puerta de enlace.

 Extensión GA
az spring gateway custom-domain show

Mostrar detalles de un dominio personalizado.

 Extensión GA
az spring gateway custom-domain unbind

Desenlace un dominio personalizado de la puerta de enlace.

 Extensión GA
az spring gateway custom-domain update

Actualice un dominio personalizado de la puerta de enlace.

 Extensión GA
az spring gateway delete

Elimine Spring Cloud Gateway.

 Extensión GA
az spring gateway restart

Reinicie Spring Cloud Gateway.

 Extensión GA
az spring gateway route-config

Comandos para administrar configuraciones de ruta de puerta de enlace en Azure Spring Apps.

 Extensión GA
az spring gateway route-config create

Cree una configuración de ruta de puerta de enlace con reglas de enrutamiento del formato de matriz Json.

 Extensión GA
az spring gateway route-config list

Enumere todas las configuraciones de ruta de puerta de enlace existentes.

 Extensión GA
az spring gateway route-config remove

Elimine una configuración de ruta de puerta de enlace existente.

 Extensión GA
az spring gateway route-config show

Obtenga una configuración de ruta de puerta de enlace existente.

 Extensión GA
az spring gateway route-config update

Actualice una configuración de ruta de puerta de enlace existente con reglas de enrutamiento del formato de matriz Json.

 Extensión GA
az spring gateway show

Muestra la configuración, el estado de aprovisionamiento y el estado en tiempo de ejecución de la puerta de enlace.

 Extensión GA
az spring gateway sync-cert

Sincronización del certificado de puerta de enlace.

 Extensión GA
az spring gateway update

Actualice las propiedades de una puerta de enlace existente.

 Extensión GA

az spring gateway clear

Borre toda la configuración de la puerta de enlace.

az spring gateway clear --resource-group
                        --service
                        [--no-wait]

Parámetros requeridos

--resource-group -g

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

--service -s

El nombre de la instancia de Azure Spring Apps, puede configurar el servicio predeterminado mediante az configure --defaults spring=.

Parámetros opcionales

--no-wait

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

Valor predeterminado: False
Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

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

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az spring gateway create

Cree Spring Cloud Gateway.

az spring gateway create --resource-group
                         --service
                         [--instance-count]

Ejemplos

Cree Spring Cloud Gateway.

az spring gateway create -s MyService -g MyResourceGroup --instance-count 2

Parámetros requeridos

--resource-group -g

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

--service -s

El nombre de la instancia de Azure Spring Apps, puede configurar el servicio predeterminado mediante az configure --defaults spring=.

Parámetros opcionales

--instance-count

Número de instancia.

Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

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

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az spring gateway delete

Elimine Spring Cloud Gateway.

az spring gateway delete --resource-group
                         --service
                         [--yes]

Parámetros requeridos

--resource-group -g

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

--service -s

El nombre de la instancia de Azure Spring Apps, puede configurar el servicio predeterminado mediante az configure --defaults spring=.

Parámetros opcionales

--yes -y

No solicita confirmación.

Valor predeterminado: False
Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

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

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az spring gateway restart

Reinicie Spring Cloud Gateway.

az spring gateway restart --resource-group
                          --service
                          [--no-wait]
                          [--yes]

Ejemplos

Reinicie Spring Cloud Gateway.

az spring gateway restart -s MyService -g MyResourceGroup

Parámetros requeridos

--resource-group -g

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

--service -s

El nombre de la instancia de Azure Spring Apps, puede configurar el servicio predeterminado mediante az configure --defaults spring=.

Parámetros opcionales

--no-wait

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

Valor predeterminado: False
--yes -y

No solicita confirmación.

Valor predeterminado: False
Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

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

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az spring gateway show

Muestra la configuración, el estado de aprovisionamiento y el estado en tiempo de ejecución de la puerta de enlace.

az spring gateway show --resource-group
                       --service

Parámetros requeridos

--resource-group -g

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

--service -s

El nombre de la instancia de Azure Spring Apps, puede configurar el servicio predeterminado mediante az configure --defaults spring=.

Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

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

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az spring gateway sync-cert

Sincronización del certificado de puerta de enlace.

az spring gateway sync-cert --resource-group
                            --service
                            [--no-wait]
                            [--yes]

Ejemplos

Sincronización del certificado de puerta de enlace.

az spring gateway sync-cert -s MyService -g MyResourceGroup

Parámetros requeridos

--resource-group -g

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

--service -s

El nombre de la instancia de Azure Spring Apps, puede configurar el servicio predeterminado mediante az configure --defaults spring=.

Parámetros opcionales

--no-wait

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

Valor predeterminado: False
--yes -y

No solicita confirmación.

Valor predeterminado: False
Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

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

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az spring gateway update

Actualice las propiedades de una puerta de enlace existente.

az spring gateway update --resource-group
                         --service
                         [--addon-configs-file]
                         [--addon-configs-json]
                         [--allow-credentials {false, true}]
                         [--allow-origin-patterns]
                         [--allowed-headers]
                         [--allowed-methods]
                         [--allowed-origins]
                         [--api-description]
                         [--api-doc-location]
                         [--api-title]
                         [--api-version]
                         [--apm-types]
                         [--apms]
                         [--assign-endpoint {false, true}]
                         [--certificate-names]
                         [--client-id]
                         [--client-secret]
                         [--cpu]
                         [--enable-cert-verify {false, true}]
                         [--enable-response-cache {false, true}]
                         [--exposed-headers]
                         [--https-only {false, true}]
                         [--instance-count]
                         [--issuer-uri]
                         [--max-age]
                         [--memory]
                         [--no-wait]
                         [--properties]
                         [--response-cache-scope]
                         [--response-cache-size]
                         [--response-cache-ttl]
                         [--scope]
                         [--secrets]
                         [--server-url]

Ejemplos

Actualice la propiedad de puerta de enlace.

az spring gateway update -s MyService -g MyResourceGroup --assign-endpoint true --https-only true

Habilite y configure la caché de respuestas en el nivel de ruta y establezca ttl en 5 minutos.

az spring gateway update -s MyService -g MyResourceGroup --enable-response-cache --response-cache-scope Route --response-cache-ttl 5m

Cuando la caché de respuestas está habilitada, actualice ttl a 3 minutos.

az spring gateway update -s MyService -g MyResourceGroup --response-cache-ttl 3m

Deshabilite la caché de respuestas.

az spring gateway update -s MyService -g MyResourceGroup --enable-response-cache false

Parámetros requeridos

--resource-group -g

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

--service -s

El nombre de la instancia de Azure Spring Apps, puede configurar el servicio predeterminado mediante az configure --defaults spring=.

Parámetros opcionales

--addon-configs-file

Ruta de acceso del archivo de la cadena JSON de configuraciones de complementos.

--addon-configs-json

Cadena JSON de configuraciones de complementos.

--allow-credentials

Si se admiten credenciales de usuario en solicitudes entre sitios.

Valores aceptados: false, true
--allow-origin-patterns --allowed-origin-patterns

Lista separada por comas de patrones de origen permitidos para realizar solicitudes entre sitios.

--allowed-headers

Lista separada por comas de encabezados permitidos en solicitudes entre sitios. El valor * especial permite que las solicitudes reales envíen cualquier encabezado.

--allowed-methods

Lista separada por comas de métodos HTTP permitidos en solicitudes entre sitios. El valor * especial permite todos los métodos.

--allowed-origins

Lista separada por comas de orígenes permitidos para realizar solicitudes entre sitios. El valor * especial permite todos los dominios.

--api-description

Descripción detallada de las API disponibles en la instancia de puerta de enlace.

--api-doc-location

Ubicación de documentación adicional para las API disponibles en la instancia de puerta de enlace.

--api-title

Título que describe el contexto de las API disponibles en la instancia de puerta de enlace.

--api-version

Versión de las API disponibles en esta instancia de puerta de enlace.

--apm-types

Lista separada por espacios de APM integrada con la puerta de enlace. Los valores permitidos son: Application Ideas, AppDynamics, Dynatrace, NewRelic, ElasticAPM.

--apms

Lista separada por espacios de nombres de referencia de APM en Azure Spring Apps para integrarse con gateway.

--assign-endpoint

Si es true, asigne la dirección URL del punto de conexión para el acceso directo.

Valores aceptados: false, true
--certificate-names

Lista separada por comas de nombres de certificado en Azure Spring Apps.

--client-id

Identificador público de la aplicación.

--client-secret

El secreto conocido solo para la aplicación y el servidor de autorización.

--cpu

Cantidad de recursos de CPU. Debe ser de 500 m o número de núcleos de CPU.

--enable-cert-verify --enable-certificate-verification

Si es true, comprobará el certificado en la conexión TLS desde la puerta de enlace a la aplicación.

Valores aceptados: false, true
--enable-response-cache

Habilite la configuración de caché de respuestas en Spring Cloud Gateway.

Valores aceptados: false, true
--exposed-headers

Lista separada por comas de encabezados de respuesta HTTP que se van a exponer para las solicitudes entre sitios.

--https-only

Si es true, acceda al punto de conexión a través de https.

Valores aceptados: false, true
--instance-count

Número de instancia.

--issuer-uri

Identificador URI del emisor.

--max-age

Durante cuántos segundos pueden los clientes almacenar en caché la respuesta de una solicitud preparatoria.

--memory

Cantidad de recursos de memoria. Debe ser 512Mi o #Gi, por ejemplo, 1Gi, 3Gi.

--no-wait

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

Valor predeterminado: False
--properties

Propiedades no confidenciales para variables de entorno. Dar formato a "key[=value]" y separados por espacio.

--response-cache-scope

El ámbito de la caché de respuestas, los valores disponibles son [Route, Instance].

--response-cache-size

Tamaño máximo de la memoria caché que determina si la memoria caché debe expulsar algunas entradas. Algunos ejemplos son [1 GB, 10 MB, 100 KB]. Use "valor predeterminado" para restablecer y la puerta de enlace administrará esta propiedad.

--response-cache-ttl

Tiempo antes de que expire una entrada almacenada en caché. Algunos ejemplos son [1h, 30m, 50s]. Use "valor predeterminado" para restablecer y la puerta de enlace administrará esta propiedad.

--scope

La lista separada por comas de las aplicaciones de acciones específicas se puede realizar en nombre de un usuario.

--secrets

Propiedades confidenciales para las variables de entorno. Una vez puesto, se cifrará y no se devolverá. Dar formato a "key[=value]" y separados por espacio.

--server-url

Dirección URL base que los consumidores de API usarán para acceder a las API en la instancia de puerta de enlace.

Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

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

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.