az spring api-portal
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 api-portal. 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 portal de API no Azure Spring Apps.
Comandos
| Name | Description | Tipo | Status |
|---|---|---|---|
| az spring api-portal clear |
Limpe todas as configurações do portal da API. |
Extensão | Deprecated |
| az spring api-portal create |
Crie um portal de API. |
Extensão | Deprecated |
| az spring api-portal custom-domain |
Comandos para gerenciar domínios personalizados para o portal da API. |
Extensão | Deprecated |
| az spring api-portal custom-domain bind |
Associe um domínio personalizado ao portal da API. |
Extensão | Deprecated |
| az spring api-portal custom-domain list |
Liste todos os domínios personalizados do portal da API. |
Extensão | Deprecated |
| az spring api-portal custom-domain show |
Mostrar detalhes de um domínio personalizado. |
Extensão | Deprecated |
| az spring api-portal custom-domain unbind |
Desvincule um domínio personalizado do portal da API. |
Extensão | Deprecated |
| az spring api-portal custom-domain update |
Atualize um domínio personalizado do portal da API. |
Extensão | Deprecated |
| az spring api-portal delete |
Exclua o portal da API. |
Extensão | Deprecated |
| az spring api-portal show |
Mostrar as configurações, o status de provisionamento e o status de tempo de execução do portal da API. |
Extensão | Deprecated |
| az spring api-portal update |
Atualize as propriedades de um portal de API existente. |
Extensão | Deprecated |
az spring api-portal 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 portal da API.
az spring api-portal clear --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 api-portal create
Este comando é implicitamente preterido porque o grupo de comandos 'spring' foi preterido e será removido em uma versão futura.
Crie um portal de API.
az spring api-portal create --resource-group
--service
[--instance-count]
Exemplos
Crie um portal de API.
az spring api-portal create -s MyService -g MyResourceGroup --instance-count 1
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 api-portal delete
Este comando é implicitamente preterido porque o grupo de comandos 'spring' foi preterido e será removido em uma versão futura.
Exclua o portal da API.
az spring api-portal 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 api-portal 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 portal da API.
az spring api-portal 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 api-portal 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 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 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.
Se verdadeiro, atribua URL do ponto de extremidade para acesso direto.
| Propriedade | Valor |
|---|---|
| Valores aceites: | false, true |
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 |
Experimente a API enviando solicitações e visualizando respostas no portal da API.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Try out API Arguments |
| Valores aceites: | false, true |
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 |
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 |
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 |