az spring api-portal

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 se instalará automáticamente la primera vez que ejecute un comando az spring api-portal. Más información sobre las extensiones.

(Solo nivel De empresa) Comandos para administrar el portal de API en Azure Spring Apps.

Comandos

Nombre	Description	Tipo	Estado
az spring api-portal clear	Borre toda la configuración del portal de API.	Extensión	GA
az spring api-portal create	Creación del portal de API.	Extensión	GA
az spring api-portal custom-domain	Comandos para administrar dominios personalizados para el portal de API.	Extensión	GA
az spring api-portal custom-domain bind	Enlace de un dominio personalizado con el portal de API.	Extensión	GA
az spring api-portal custom-domain list	Enumere todos los dominios personalizados del portal de API.	Extensión	GA
az spring api-portal custom-domain show	Mostrar detalles de un dominio personalizado.	Extensión	GA
az spring api-portal custom-domain unbind	Desenlace un dominio personalizado del portal de API.	Extensión	GA
az spring api-portal custom-domain update	Actualice un dominio personalizado del portal de API.	Extensión	GA
az spring api-portal delete	Elimine el portal de API.	Extensión	GA
az spring api-portal show	Muestra la configuración, el estado de aprovisionamiento y el estado en tiempo de ejecución del portal de API.	Extensión	GA
az spring api-portal update	Actualice las propiedades existentes del portal de API.	Extensión	GA

az spring api-portal clear

Borre toda la configuración del portal de API.

az spring api-portal clear --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=<name>.

Parámetros globales

--debug

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

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, supresión de advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

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

az spring api-portal create

Creación del portal de API.

az spring api-portal create --resource-group
                            --service
                            [--instance-count]

Ejemplos

Creación del portal de API.

az spring api-portal create -s MyService -g MyResourceGroup --instance-count 1

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=<name>.

Parámetros opcionales

--instance-count

Número de instancias.

Parámetros globales

--debug

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

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, supresión de advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

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

az spring api-portal delete

Elimine el portal de API.

az spring api-portal 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=<name>.

Parámetros opcionales

--yes -y

No solicite confirmación.

Valor predeterminado: False

Parámetros globales

--debug

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

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, supresión de advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

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

az spring api-portal show

Muestra la configuración, el estado de aprovisionamiento y el estado en tiempo de ejecución del portal de API.

az spring api-portal 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=<name>.

Parámetros globales

--debug

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

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, supresión de advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

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

az spring api-portal update

Actualice las propiedades existentes del portal de API.

az spring api-portal update --resource-group
                            --service
                            [--assign-endpoint {false, true}]
                            [--client-id]
                            [--client-secret]
                            [--enable-api-try-out {false, true}]
                            [--https-only {false, true}]
                            [--instance-count]
                            [--issuer-uri]
                            [--scope]

Ejemplos

Actualice la propiedad del portal de API.

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

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=<name>.

Parámetros opcionales

--assign-endpoint

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

Valores aceptados: false, true

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

--enable-api-try-out

Pruebe la API mediante el envío de solicitudes y la visualización de respuestas en el portal de API.

Valores aceptados: false, true

--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 instancias.

--issuer-uri

Identificador URI del emisor.

--scope

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

Parámetros globales

--debug

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

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, supresión de advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc

Valor predeterminado: json

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

Compartir vía

az spring api-portal

Comandos

az spring api-portal clear

Parámetros requeridos

az spring api-portal create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az spring api-portal delete

Parámetros requeridos

Parámetros opcionales

az spring api-portal show

Parámetros requeridos

az spring api-portal update

Ejemplos

Parámetros requeridos

Parámetros opcionales

Recursos adicionales