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

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

Preterido

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az spring gateway create

Preterido

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--instance-count

Número de instâncias.

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az spring gateway delete

Preterido

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az spring gateway restart

Preterido

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az spring gateway show

Preterido

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

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

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az spring gateway sync-cert

Preterido

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az spring gateway update

Preterido

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--addon-configs-file

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

Propriedade Valor
Parameter group: Add-on Configurations Arguments
--addon-configs-json

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

Propriedade Valor
Parameter group: Add-on Configurations Arguments
--allow-credentials

Se as credenciais do usuário são suportadas em solicitações entre sites.

Propriedade Valor
Parameter group: Cross-origin Resource Sharing (CORS) Arguments
Valores aceites: 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
Parameter group: 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
Parameter group: 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
Parameter group: 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
Parameter group: Cross-origin Resource Sharing (CORS) Arguments
--api-description

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

Propriedade Valor
Parameter group: API metadata Arguments
--api-doc-___location

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

Propriedade Valor
Parameter group: API metadata Arguments
--api-title

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

Propriedade Valor
Parameter group: API metadata Arguments
--api-version

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

Propriedade Valor
Parameter group: API metadata Arguments
--apm-types

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

Propriedade Valor
Parameter group: APM Arguments
--apms

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

Propriedade Valor
Parameter group: APM Arguments
--assign-endpoint

Se verdadeiro, atribua URL do ponto de extremidade para acesso direto.

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

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

Propriedade Valor
Parameter group: Client Certificate Authentication Arguments
--client-id

O identificador público do aplicativo.

Propriedade Valor
Parameter group: Single Sign On (SSO) Arguments
--client-secret

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

Propriedade Valor
Parameter group: 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 verdadeiro, verificará o certificado na conexão TLS do gateway para o aplicativo.

Propriedade Valor
Parameter group: Client Certificate Authentication Arguments
Valores aceites: false, true
--enable-response-cache

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

Propriedade Valor
Parameter group: Response Cache Arguments
Valores aceites: 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
Parameter group: Cross-origin Resource Sharing (CORS) Arguments
--https-only

Se verdadeiro, acesse o ponto de extremidade via https.

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

Número de instâncias.

--issuer-uri

O URI do identificador do emissor.

Propriedade Valor
Parameter group: Single Sign On (SSO) Arguments
--max-age

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

Propriedade Valor
Parameter group: 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 espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--properties

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

--response-cache-scope

Escopo para cache de resposta, os valores disponíveis são [Route, Instance].

Propriedade Valor
Parameter group: Response Cache Arguments
--response-cache-size

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
Parameter group: Response Cache Arguments
--response-cache-ttl

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
Parameter group: Response Cache Arguments
--scope

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
Parameter group: Single Sign On (SSO) Arguments
--secrets

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.

--server-url

URL base que os consumidores de API usarão para acessar APIs na instância do Gateway.

Propriedade Valor
Parameter group: API metadata Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False