Compartilhar via

az spring gateway

  • Preterido

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 instalará automaticamente na primeira vez que você executar um comando az spring gateway. Saiba mais sobre extensões.

Esse grupo de comandos foi substituído implicitamente 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

Nome 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

Desassocie 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

Mostre 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

Preterido

Esse comando foi substituído implicitamente 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 Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service -s

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az spring gateway create

Preterido

Esse comando foi substituído implicitamente 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 Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service -s

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--instance-count

Número de instância.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az spring gateway delete

Preterido

Esse comando foi substituído implicitamente 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 Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service -s

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--yes -y

Não solicite confirmação.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az spring gateway restart

Preterido

Esse comando foi substituído implicitamente 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 Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service -s

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--yes -y

Não solicite confirmação.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az spring gateway show

Preterido

Esse comando foi substituído implicitamente porque o grupo de comandos 'spring' foi preterido e será removido em uma versão futura.

Mostre 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 Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service -s

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 Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az spring gateway sync-cert

Preterido

Esse comando foi substituído implicitamente 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 Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service -s

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--yes -y

Não solicite confirmação.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az spring gateway update

Preterido

Esse comando foi substituído implicitamente 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 a 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 da rota e defina ttl como 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 habilitado, atualize o ttl para 3 minutos.

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

Desabilite o cache de resposta.

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

Parâmetros Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service -s

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 se tornar obrigatórios para que o comando seja executado com sucesso.

--addon-configs-file

O caminho do arquivo da cadeia de caracteres JSON das configurações de complemento.

Propriedade Valor
Grupo de parâmetros: Add-on Configurations Arguments
--addon-configs-json

Cadeia de caracteres JSON de configurações de complemento.

Propriedade Valor
Grupo de parâmetros: Add-on Configurations Arguments
--allow-credentials

Se há suporte para credenciais de usuário em solicitações entre sites.

Propriedade Valor
Grupo de parâmetros: Cross-origin Resource Sharing (CORS) Arguments
Valores aceitos: false, true
--allow-origin-patterns --allowed-origin-patterns

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
--allowed-headers

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
--allowed-methods

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
--allowed-origins

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
--api-description

Descrição detalhada das APIs disponíveis na instância do Gateway.

Propriedade Valor
Grupo de parâmetros: API metadata Arguments
--api-doc-location

Local da documentação adicional para as APIs disponíveis na instância do Gateway.

Propriedade Valor
Grupo de parâmetros: API metadata Arguments
--api-title

Título que descreve o contexto das APIs disponíveis na instância do Gateway.

Propriedade Valor
Grupo de parâmetros: API metadata Arguments
--api-version

Versão das APIs disponíveis nesta instância do Gateway.

Propriedade Valor
Grupo de parâmetros: API metadata Arguments
--apm-types

Lista separada por espaço do APM integrado ao Gateway. Os valores permitidos são: ApplicationInsights, AppDynamics, Dynatrace, NewRelic, ElasticAPM.

Propriedade Valor
Grupo de parâmetros: APM Arguments
--apms

Lista separada por espaço de nomes de referência do APM no Azure Spring Apps para integrar ao Gateway.

Propriedade Valor
Grupo de parâmetros: APM Arguments
--assign-endpoint

Se for true, atribua a URL do ponto de extremidade para acesso direto.

Propriedade Valor
Valores aceitos: false, true
--certificate-names

Lista separada por vírgulas de nomes de certificado no Azure Spring Apps.

Propriedade Valor
Grupo de parâmetros: Client Certificate Authentication Arguments
--client-id

O identificador público do aplicativo.

Propriedade Valor
Grupo de parâmetros: Single Sign On (SSO) Arguments
--client-secret

O segredo conhecido apenas pelo aplicativo e pelo servidor de autorização.

Propriedade Valor
Grupo de parâmetros: Single Sign On (SSO) Arguments
--cpu

Quantidade de recursos da CPU. Deve ser 500m ou número de núcleos de CPU.

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

Se for true, verificará o certificado na conexão TLS do gateway para o aplicativo.

Propriedade Valor
Grupo de parâmetros: Client Certificate Authentication Arguments
Valores aceitos: false, true
--enable-response-cache

Habilite as configurações de cache de resposta no Spring Cloud Gateway.

Propriedade Valor
Grupo de parâmetros: Response Cache Arguments
Valores aceitos: false, true
--exposed-headers

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
--https-only

Se for true, acesse o ponto de extremidade por meio de https.

Propriedade Valor
Valores aceitos: false, true
--instance-count

Número de instância.

--issuer-uri

O URI do Identificador do Emissor.

Propriedade Valor
Grupo de parâmetros: Single Sign On (SSO) Arguments
--max-age

Por quanto tempo, em segundos, a resposta de uma solicitação pré-lançamento pode ser armazenada em cache pelos clientes.

Propriedade Valor
Grupo de parâmetros: Cross-origin Resource Sharing (CORS) Arguments
--memory

Quantidade de recursos de memória. Deve ser 512Mi ou #Gi, por exemplo, 1Gi, 3Gi.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--properties

Propriedades não confidenciais para variáveis de ambiente. Formate "key[=value]" e separado por espaço.

--response-cache-scope

Escopo do cache de resposta, os valores disponíveis são [Rota, Instância].

Propriedade Valor
Grupo de parâmetros: Response Cache Arguments
--response-cache-size

Tamanho máximo do cache que determina se o cache precisa remover algumas entradas. Os exemplos são [1 GB, 10 MB, 100 KB]. Use "padrão" para redefinir e o Gateway gerenciará essa propriedade.

Propriedade Valor
Grupo de parâmetros: Response Cache Arguments
--response-cache-ttl

Tempo antes de uma entrada armazenada em cache expirar. Os exemplos são [1h, 30m, 50s]. Use "padrão" para redefinir e o Gateway gerenciará essa propriedade.

Propriedade Valor
Grupo de parâmetros: Response Cache Arguments
--scope

A lista separada por vírgulas das ações específicas que os aplicativos podem fazer em nome de um usuário.

Propriedade Valor
Grupo de parâmetros: Single Sign On (SSO) Arguments
--secrets

Propriedades confidenciais para variáveis de ambiente. Depois de colocado, ele será criptografado e não retornado. Formate "key[=value]" e separado por espaço.

--server-url

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 Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False