az spring gateway
Observação
Essa referência faz parte da extensão spring para a CLI do Azure (versão 2.56.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando
Este grupo de comandos foi implicitamente preterido porque o grupo de comandos 'spring' foi preterido e será removido em uma versão futura.
(Somente nível Enterprise) Comandos para gerenciar o gateway no Azure Spring Apps.
Comandos
| Name | Description | Tipo | Status |
|---|---|---|---|
| az spring gateway clear |
Limpe todas as configurações do gateway. |
Extensão | Deprecated |
| az spring gateway create |
Crie o Spring Cloud Gateway. |
Extensão | Deprecated |
| az spring gateway custom-domain |
Comandos para gerenciar domínios personalizados para gateway. |
Extensão | Deprecated |
| az spring gateway custom-domain bind |
Associe um domínio personalizado ao gateway. |
Extensão | Deprecated |
| az spring gateway custom-domain list |
Liste todos os domínios personalizados do gateway. |
Extensão | Deprecated |
| az spring gateway custom-domain show |
Mostrar detalhes de um domínio personalizado. |
Extensão | Deprecated |
| az spring gateway custom-domain unbind |
Desvincule um domínio personalizado do gateway. |
Extensão | Deprecated |
| az spring gateway custom-domain update |
Atualize um domínio personalizado do gateway. |
Extensão | Deprecated |
| az spring gateway delete |
Exclua o Spring Cloud Gateway. |
Extensão | Deprecated |
| az spring gateway restart |
Reinicie o Spring Cloud Gateway. |
Extensão | Deprecated |
| az spring gateway route-config |
Comandos para gerenciar configurações de rota de gateway no Azure Spring Apps. |
Extensão | Deprecated |
| az spring gateway route-config create |
Crie uma configuração de rota de gateway com regras de roteamento do formato de matriz Json. |
Extensão | Deprecated |
| az spring gateway route-config list |
Liste todas as configurações de rota de gateway existentes. |
Extensão | Deprecated |
| az spring gateway route-config remove |
Exclua uma configuração de rota de gateway existente. |
Extensão | Deprecated |
| az spring gateway route-config show |
Obtenha uma configuração de rota de gateway existente. |
Extensão | Deprecated |
| az spring gateway route-config update |
Atualize uma configuração de rota de gateway existente com regras de roteamento do formato de matriz Json. |
Extensão | Deprecated |
| az spring gateway show |
Mostrar as configurações, o status de provisionamento e o status de tempo de execução do gateway. |
Extensão | Deprecated |
| az spring gateway sync-cert |
Certificado de sincronização do gateway. |
Extensão | Deprecated |
| az spring gateway update |
Atualize as propriedades de um gateway existente. |
Extensão | Deprecated |
az spring gateway clear
Este comando é implicitamente preterido porque o grupo de comandos 'spring' foi preterido e será removido em uma versão futura.
Limpe todas as configurações do gateway.
az spring gateway clear --resource-group
--service
[--no-wait]
Parâmetros Obrigatórios
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da instância do Azure Spring Apps, você pode configurar o serviço padrão usando az configure --defaults spring=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Não espere que a operação de longa duração termine.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az spring gateway create
Este comando é implicitamente preterido porque o grupo de comandos 'spring' foi preterido e será removido em uma versão futura.
Crie o Spring Cloud Gateway.
az spring gateway create --resource-group
--service
[--instance-count]
Exemplos
Crie o Spring Cloud Gateway.
az spring gateway create -s MyService -g MyResourceGroup --instance-count 2
Parâmetros Obrigatórios
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da instância do Azure Spring Apps, você pode configurar o serviço padrão usando az configure --defaults spring=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Número de instâncias.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az spring gateway delete
Este comando é implicitamente preterido porque o grupo de comandos 'spring' foi preterido e será removido em uma versão futura.
Exclua o Spring Cloud Gateway.
az spring gateway delete --resource-group
--service
[--yes]
Parâmetros Obrigatórios
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da instância do Azure Spring Apps, você pode configurar o serviço padrão usando az configure --defaults spring=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Não solicite confirmação.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az spring gateway restart
Este comando é implicitamente preterido porque o grupo de comandos 'spring' foi preterido e será removido em uma versão futura.
Reinicie o Spring Cloud Gateway.
az spring gateway restart --resource-group
--service
[--no-wait]
[--yes]
Exemplos
Reinicie o Spring Cloud Gateway.
az spring gateway restart -s MyService -g MyResourceGroup
Parâmetros Obrigatórios
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da instância do Azure Spring Apps, você pode configurar o serviço padrão usando az configure --defaults spring=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Não espere que a operação de longa duração termine.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Não solicite confirmação.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az spring gateway show
Este comando é implicitamente preterido porque o grupo de comandos 'spring' foi preterido e será removido em uma versão futura.
Mostrar as configurações, o status de provisionamento e o status de tempo de execução do gateway.
az spring gateway show --resource-group
--service
Parâmetros Obrigatórios
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da instância do Azure Spring Apps, você pode configurar o serviço padrão usando az configure --defaults spring=<name>.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az spring gateway sync-cert
Este comando é implicitamente preterido porque o grupo de comandos 'spring' foi preterido e será removido em uma versão futura.
Certificado de sincronização do gateway.
az spring gateway sync-cert --resource-group
--service
[--no-wait]
[--yes]
Exemplos
Certificado de sincronização do gateway.
az spring gateway sync-cert -s MyService -g MyResourceGroup
Parâmetros Obrigatórios
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da instância do Azure Spring Apps, você pode configurar o serviço padrão usando az configure --defaults spring=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Não espere que a operação de longa duração termine.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Não solicite confirmação.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az spring gateway update
Este comando é implicitamente preterido porque o grupo de comandos 'spring' foi preterido e será removido em uma versão futura.
Atualize as propriedades de um gateway existente.
az spring gateway update --resource-group
--service
[--addon-configs-file]
[--addon-configs-json]
[--allow-credentials {false, true}]
[--allow-origin-patterns --allowed-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 --enable-certificate-verification {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]
Exemplos
Atualizar propriedade do gateway.
az spring gateway update -s MyService -g MyResourceGroup --assign-endpoint true --https-only true
Habilite e configure o cache de resposta no nível de rota e defina ttl para 5 minutos.
az spring gateway update -s MyService -g MyResourceGroup --enable-response-cache --response-cache-scope Route --response-cache-ttl 5m
Quando o cache de resposta estiver ativado, atualize o ttl para 3 minutos.
az spring gateway update -s MyService -g MyResourceGroup --response-cache-ttl 3m
Desative o cache de resposta.
az spring gateway update -s MyService -g MyResourceGroup --enable-response-cache false
Parâmetros Obrigatórios
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da instância do Azure Spring Apps, você pode configurar o serviço padrão usando az configure --defaults spring=<name>.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
O caminho do arquivo da cadeia de caracteres JSON de configurações de complemento.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Add-on Configurations Arguments |
Cadeia de caracteres JSON de configurações de complemento.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Add-on Configurations Arguments |
Se as credenciais do usuário são suportadas em solicitações entre sites.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Cross-origin Resource Sharing (CORS) Arguments |
| Valores aceites: | false, true |
Lista separada por vírgulas de padrões de origem permitidos para fazer solicitações entre sites.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Cross-origin Resource Sharing (CORS) Arguments |
Lista separada por vírgulas de cabeçalhos permitidos em solicitações entre sites. O valor especial * permite que solicitações reais enviem qualquer cabeçalho.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Cross-origin Resource Sharing (CORS) Arguments |
Lista separada por vírgulas de métodos HTTP permitidos em solicitações entre sites. O valor especial * permite todos os métodos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Cross-origin Resource Sharing (CORS) Arguments |
Lista separada por vírgulas de origens permitidas para fazer solicitações entre sites. O valor especial * permite todos os domínios.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Cross-origin Resource Sharing (CORS) Arguments |
Descrição detalhada das APIs disponíveis na instância do Gateway.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | API metadata Arguments |
Localização da documentação adicional para as APIs disponíveis na instância do Gateway.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | API metadata Arguments |
Título que descreve o contexto das APIs disponíveis na instância do Gateway.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | API metadata Arguments |
Versão das APIs disponíveis nesta instância do Gateway.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | API metadata Arguments |
Lista separada por espaço do APM integrado com o Gateway. Os valores permitidos são: ApplicationInsights, AppDynamics, Dynatrace, NewRelic, ElasticAPM.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | APM Arguments |
Lista separada por espaço de nomes de referência APM no Azure Spring Apps para integrar com o Gateway.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | APM Arguments |
Se verdadeiro, atribua URL do ponto de extremidade para acesso direto.
| Propriedade | Valor |
|---|---|
| Valores aceites: | false, true |
Lista separada por vírgulas de nomes de certificados no Azure Spring Apps.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Client Certificate Authentication Arguments |
O identificador público do aplicativo.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Single Sign On (SSO) Arguments |
O segredo conhecido apenas pelo aplicativo e pelo servidor de autorização.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Single Sign On (SSO) Arguments |
Quantidade de recursos da CPU. Deve ser 500m ou número de núcleos de CPU.
Se verdadeiro, verificará o certificado na conexão TLS do gateway para o aplicativo.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Client Certificate Authentication Arguments |
| Valores aceites: | false, true |
Habilite as configurações de cache de resposta no Spring Cloud Gateway.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Response Cache Arguments |
| Valores aceites: | false, true |
Lista separada por vírgulas de cabeçalhos de resposta HTTP a serem expostos para solicitações entre sites.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Cross-origin Resource Sharing (CORS) Arguments |
Se verdadeiro, acesse o ponto de extremidade via https.
| Propriedade | Valor |
|---|---|
| Valores aceites: | false, true |
Número de instâncias.
O URI do identificador do emissor.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Single Sign On (SSO) Arguments |
Por quanto tempo, em segundos, a resposta de uma solicitação de pré-voo pode ser armazenada em cache pelos clientes.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Cross-origin Resource Sharing (CORS) Arguments |
Quantidade de recursos de memória. Deve ser 512Mi ou #Gi, por exemplo, 1Gi, 3Gi.
Não espere que a operação de longa duração termine.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Propriedades não sensíveis para variáveis de ambiente. Formate "key[=value]" e separado por espaço.
Escopo para cache de resposta, os valores disponíveis são [Route, Instance].
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Response Cache Arguments |
Tamanho máximo do cache que determina se o cache precisa remover algumas entradas. Exemplos são [1GB, 10MB, 100KB]. Use "default" para redefinir e o Gateway gerenciará essa propriedade.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Response Cache Arguments |
Tempo antes de uma entrada em cache expirar. Exemplos são [1h, 30m, 50s]. Use "default" para redefinir e o Gateway gerenciará essa propriedade.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Response Cache Arguments |
Lista separada por vírgulas das ações específicas que os aplicativos podem ser autorizados a fazer em nome de um usuário.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Single Sign On (SSO) Arguments |
Propriedades sensíveis para variáveis de ambiente. Uma vez colocado, ele será criptografado e não retornado. Formate "key[=value]" e separado por espaço.
URL base que os consumidores de API usarão para acessar APIs na instância do Gateway.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | API metadata Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |