az spring api-portal

Referência

Observação

Essa referência faz parte da extensão de mola 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 api-portal . Saiba mais sobre extensões.

(Somente camada Enterprise) Comandos para gerenciar o portal de API nos Aplicativos Spring do Azure.

Comandos

Nome	Description	Tipo	Status
az spring api-portal clear	Limpe todas as configurações do portal de API.	Extensão	GA
az spring api-portal create	Criar portal de API.	Extensão	GA
az spring api-portal custom-domain	Comandos para gerenciar domínios personalizados para o portal de API.	Extensão	GA
az spring api-portal custom-domain bind	Vincular um domínio personalizado ao portal de API.	Extensão	GA
az spring api-portal custom-domain list	Liste todos os domínios personalizados do portal de API.	Extensão	GA
az spring api-portal custom-domain show	Mostrar detalhes de um domínio personalizado.	Extensão	GA
az spring api-portal custom-domain unbind	Desvincule um domínio personalizado do portal de API.	Extensão	GA
az spring api-portal custom-domain update	Atualize um domínio personalizado do portal de API.	Extensão	GA
az spring api-portal delete	Exclua o portal da API.	Extensão	GA
az spring api-portal show	Mostrar as configurações, o status de provisionamento e o status de tempo de execução do portal de API.	Extensão	GA
az spring api-portal update	Atualize as propriedades de um portal de API existente.	Extensão	GA

az spring api-portal clear

Limpe todas as configurações do portal de API.

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

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

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

Valor padrão: json

--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 o detalhamento do log. Use --debug para logs de depuração completos.

az spring api-portal create

Criar portal de API.

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

Exemplos

Criar portal de API.

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

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

Parâmetros Opcionais

--instance-count

Número de instâncias.

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

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

Valor padrão: json

--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 o detalhamento do log. Use --debug para logs de depuração completos.

az spring api-portal delete

Exclua o portal da API.

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

Parâmetros Opcionais

--yes -y

Não solicite confirmação.

Valor padrão: False

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

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

Valor padrão: json

--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 o detalhamento do log. Use --debug para logs de depuração completos.

az spring api-portal show

Mostrar as configurações, o status de provisionamento e o status de tempo de execução do portal de API.

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

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

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

Valor padrão: json

--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 o detalhamento do log. Use --debug para logs de depuração completos.

az spring api-portal update

Atualize as propriedades de um portal de API existente.

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]

Exemplos

Atualize a propriedade do portal da API.

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

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

Parâmetros Opcionais

--assign-endpoint

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

Valores aceitos: false, true

--client-id

O identificador público do aplicativo.

--client-secret

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

--enable-api-try-out

Experimente a API enviando solicitações e exibindo respostas no portal da API.

Valores aceitos: false, true

--https-only

Se verdadeiro, acesse o endpoint via https.

Valores aceitos: false, true

--instance-count

Número de instâncias.

--issuer-uri

O URI do identificador do emissor.

--scope

Lista separada por vírgulas das ações específicas que os aplicativos podem ter permissão para fazer em nome de um usuário.

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

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

Valor padrão: json

--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 o detalhamento do log. Use --debug para logs de depuração completos.

Compartilhar via

az spring api-portal

Comandos

az spring api-portal clear

Parâmetros Exigidos

az spring api-portal create

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az spring api-portal delete

Parâmetros Exigidos

Parâmetros Opcionais

az spring api-portal show

Parâmetros Exigidos

az spring api-portal update

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

Recursos adicionais