Compartilhar via

az spring api-portal

  • Referência

Nota

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 a primeira vez que você executar um comando az spring api-portal. Saiba mais sobre extensões.

(Somente camada da empresa) Comandos para gerenciar o portal de API no Azure Spring Apps.

Comandos

Nome Description Tipo Status
az spring api-portal clear

Desmarque 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

Associe um domínio personalizado ao portal de API.

 Extensão GA
az spring api-portal custom-domain list

Listar 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

Desvinme 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

Excluir portal de API.

 Extensão GA
az spring api-portal show

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

 Extensão GA
az spring api-portal update

Atualize as propriedades existentes do portal de API.

 Extensão GA

az spring api-portal clear

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em 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=<name>.

Parâmetros Opcionais

--instance-count

Número de instância.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

az spring api-portal delete

Excluir portal de 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=<name>.

Parâmetros Opcionais

--yes -y

Não solicite confirmação.

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

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em 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 runtime 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=<name>.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

az spring api-portal update

Atualize as propriedades existentes do 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]

Exemplos

Atualizar a propriedade do portal de 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=<name>.

Parâmetros Opcionais

--assign-endpoint

Se for true, 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 de API.

Valores aceitos: false, true
--https-only

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

Valores aceitos: false, true
--instance-count

Número de instância.

--issuer-uri

O URI do Identificador do Emissor.

--scope

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.