Início Rápido: Implantar o aplicativo de API RESTful nos Aplicativos Spring do Azure

Observação

As primeiras 50 horas de vCPU e os primeiros 100 GB de memória são gratuitos todos os meses. Para obter mais informações, confira Redução de preços – os Aplicativos Spring do Azure fazem mais, custando menos no blog Apps on Azure.

Observação

Azure Spring Apps é o novo nome do serviço Azure Spring Cloud. Embora o serviço tenha um novo nome, você verá o nome antigo em alguns locais por um tempo enquanto trabalhamos para atualizar ativos como capturas de tela, vídeos e diagramas.

Este artigo descreve como implantar um aplicativo de API RESTful protegido pelo Microsoft Entra ID nos Aplicativos Spring do Azure. O projeto de exemplo é uma versão simplificada com base no aplicativo Web Simple Todo, que fornece apenas o serviço de back-end e usa o Microsoft Entra ID para proteger as APIs RESTful.

Essas APIs RESTful são protegidas pela aplicação do RBAC (controle de acesso baseado em função). Usuários anônimos não podem acessar dados e não têm permissão para controlar o acesso de usuários diferentes. Os usuários anônimos só têm as três permissões a seguir:

• Leitura: com essa permissão, um usuário pode ler os dados do ToDo.
• Gravação: com essa permissão, um usuário pode adicionar ou atualizar os dados do ToDo.
• Exclusão: com essa permissão, um usuário pode excluir os dados do ToDo.

Depois que a implantação for bem-sucedida, você poderá exibir e testar as APIs por meio da interface do usuário do Swagger.

O diagrama a seguir mostra a arquitetura do sistema:

Este artigo descreve as seguintes opções para criar recursos e implantá-los nos Aplicativos Spring do Azure:

• A opção do portal do Azure + plug-in do Maven fornece uma maneira mais convencional de criar recursos e implantar aplicativos passo a passo. Esta opção é adequada para os desenvolvedores do Spring que estão usando os serviços de nuvem do Azure pela primeira vez.
• A opção do Azure Developer CLI é a maneira mais eficiente de criar recursos e implantar aplicativos automaticamente por meio de comandos simples. O Azure Developer CLI usa um modelo para provisionar os recursos do Azure necessários e implantar o código do aplicativo. Essa opção é adequada para os desenvolvedores do Spring que estão familiarizados com os serviços de nuvem do Azure.

Este artigo descreve as seguintes opções para criar recursos e implantá-los nos Aplicativos Spring do Azure:

• A opção do portal do Azure + plug-in do Maven fornece uma maneira mais convencional de criar recursos e implantar aplicativos passo a passo. Esta opção é adequada para os desenvolvedores do Spring que estão usando os serviços de nuvem do Azure pela primeira vez.
• A opção CLI do Azure é uma ferramenta de linha de comando poderosa para gerenciar recursos do Azure. Essa opção é adequada para os desenvolvedores do Spring que estão familiarizados com os serviços de nuvem do Azure.

1. Pré-requisitos

Portal do Azure + plug-in do Maven

• Uma assinatura do Azure. Caso você não tenha uma assinatura do Azure, crie uma conta gratuita do Azure antes de começar.

• Uma das seguintes funções:

  • Administrador Global ou Administrador de Funções com Privilégios, para conceder o consentimento aos aplicativos que solicitam qualquer permissão em qualquer API.
  • Administrador de Aplicativos de Nuvem ou Administrador de Aplicativos, para fornecer consentimento aos aplicativos que solicitam qualquer permissão em qualquer API, exceto as funções de aplicativo do Microsoft Graph (permissões de aplicativo).
  • Uma função de diretório personalizada que inclui a permissão para conceder permissões a aplicativos, para as permissões exigidas pelo aplicativo.

  Para obter mais informações, consulte Permitir consentimento de administrador em todo locatário para um aplicativo.

• Se você estiver implantando a instância do plano Enterprise do Aplicativos Spring do Azure pela primeira vez na assinatura de destino, confira a seção Requisitos do plano Enterprise no Azure Marketplace.

• Git.

• Kit de Desenvolvimento Java (JDK), versão 17.

• Um locatário do Microsoft Entra. Para obter instruções sobre como criar um, consulte Início Rápido: Criar um novo locatário no Microsoft Entra ID.

CLI do Azure

• Uma assinatura do Azure, se você não tiver, crie uma conta gratuita do Azure antes de começar.

• Uma das seguintes funções:

  • Administrador Global ou Administrador de Funções com Privilégios, para conceder o consentimento aos aplicativos que solicitam qualquer permissão em qualquer API.
  • Administrador de Aplicativos de Nuvem ou Administrador de Aplicativos, para fornecer consentimento aos aplicativos que solicitam qualquer permissão em qualquer API, exceto as funções de aplicativo do Microsoft Graph (permissões de aplicativo).
  • Uma função de diretório personalizada que inclui a permissão para conceder permissões a aplicativos, para as permissões exigidas pelo aplicativo.

  Para obter mais informações, consulte Permitir consentimento de administrador em todo locatário para um aplicativo.

• Se você estiver implantando a instância do plano Enterprise do Aplicativos Spring do Azure pela primeira vez na assinatura de destino, confira a seção Requisitos do plano Enterprise no Azure Marketplace.

• Git.

• Kit de Desenvolvimento Java (JDK), versão 17.

• Um locatário do Microsoft Entra. Para obter instruções sobre como criar um, consulte Início Rápido: Criar um novo locatário no Microsoft Entra ID.

• CLI do Azure: versão 2.53.1 ou posterior.

Portal do Azure + plug-in do Maven

• Uma assinatura do Azure, se você não tiver, crie uma conta gratuita do Azure antes de começar.

• Uma das seguintes funções:

  • Administrador Global ou Administrador de Funções com Privilégios, para conceder o consentimento aos aplicativos que solicitam qualquer permissão em qualquer API.
  • Administrador de Aplicativos de Nuvem ou Administrador de Aplicativos, para fornecer consentimento aos aplicativos que solicitam qualquer permissão em qualquer API, exceto as funções de aplicativo do Microsoft Graph (permissões de aplicativo).
  • Uma função de diretório personalizada que inclui a permissão para conceder permissões a aplicativos, para as permissões exigidas pelo aplicativo.

  Para obter mais informações, consulte Permitir consentimento de administrador em todo locatário para um aplicativo.

• Git.

• Kit de Desenvolvimento Java (JDK), versão 17.

• Um locatário do Microsoft Entra. Para obter instruções sobre como criar um, consulte Início Rápido: Criar um novo locatário no Microsoft Entra ID.

CLI do Desenvolvedor do Azure

• Uma assinatura do Azure, se você não tiver, crie uma conta gratuita do Azure antes de começar.

• Uma das seguintes funções:

  • Administrador Global ou Administrador de Funções com Privilégios, para conceder o consentimento aos aplicativos que solicitam qualquer permissão em qualquer API.
  • Administrador de Aplicativos de Nuvem ou Administrador de Aplicativos, para fornecer consentimento aos aplicativos que solicitam qualquer permissão em qualquer API, exceto as funções de aplicativo do Microsoft Graph (permissões de aplicativo).
  • Uma função de diretório personalizada que inclui a permissão para conceder permissões a aplicativos, para as permissões exigidas pelo aplicativo.

  Para obter mais informações, consulte permitir consentimento do administrador.

• Git.

• Kit de Desenvolvimento Java (JDK), versão 17.

• Um locatário do Microsoft Entra. Para obter instruções sobre como criar um, consulte Início Rápido: Criar um novo locatário no Microsoft Entra ID.

• Versão 1.0.2 ou superior do Azure Developer CLI (AZD),.

2. Preparar o projeto Spring

Para implantar o aplicativo de API RESTful, a primeira etapa é preparar o projeto Spring para ser executado localmente.

Use as etapas a seguir para clonar e executar o aplicativo localmente:

1. Use o seguinte comando para clonar o projeto de exemplo do GitHub:

   git clone https://github.com/Azure-Samples/ASA-Samples-Restful-Application.git
   

2. Se você quiser executar o aplicativo localmente, conclua as etapas nas seções Expor RESTful APIs e Atualizar configuração do aplicativo primeiro e use o seguinte comando para executar o aplicativo de exemplo com o Maven:

   cd ASA-Samples-Restful-Application
   ./mvnw spring-boot:run
   

3. Preparar o ambiente de nuvem

Os principais recursos necessários para executar esse aplicativo de exemplo são uma instância dos Aplicativos Spring do Azure e uma instância do Banco de Dados do Azure para PostgreSQL. As seções a seguir descrevem como criar esses recursos.

Portal do Azure + plug-in do Maven

3.1. Entre no Portal do Azure

Acesse o portal do Azure e insira suas credenciais para entrar no portal. A exibição padrão é o painel de serviço.

3.2. Criar uma instância do Azure Spring Apps

Use o seguinte comando para criar uma instância de serviço do Aplicativos Spring do Azure:

1. Selecione Criar um recurso no canto do portal do Azure.

2. Selecione Computação>Aplicativos Spring do Azure.

3. Preencha o formulário Básico com as seguintes informações:

   Configuração	Valor sugerido	Descrição
   Assinatura	O nome da sua assinatura.	A assinatura do Azure que você deseja usar para o servidor. Caso você tenha várias assinaturas, escolha a assinatura na qual você deseja receber a cobrança do recurso.
   Grupo de recursos	myresourcegroup	Um novo nome do grupo de recursos ou um existente de sua assinatura.
   Nome	myasa	Um nome exclusivo que identifica o serviço Aplicativos Spring do Azure. O nome deve ter entre 4 e 32 caracteres e pode conter apenas letras minúsculas, números e hifens. O primeiro caractere do nome do serviço deve ser uma letra e o último caractere deve ser uma letra ou um número.
   Plano	Empresa	O plano de preços determina os recursos e o custo associados à sua instância.
   Região	A região mais próxima de seus usuários.	A localização mais próxima dos usuários.
   Com Redundância de Zona	Desmarcado	A opção para criar o serviço do Aplicativos Spring do Azure em uma zona de disponibilidade do Azure. Atualmente, não há suporte para esse recurso em todas as regiões.
   Plano IP de software	Pago conforme o uso	O plano de preços que permite pagar conforme o uso do Aplicativos Spring do Azure.
   Terms	Selecionadas	A caixa de seleção do contrato associada à Oferta do Marketplace. Você precisa selecionar essa caixa de seleção.
   Implantar um projeto de exemplo	Desmarcado	A opção para usar o aplicativo de exemplo interno.

4. Selecione Revisar e criar para revisar suas seleções. Em seguida, selecione Criar para provisionar a instância dos Aplicativos Spring do Azure.

5. Na barra de ferramentas, selecione o ícone (sino) Notificações para monitorar o processo de implantação. Após a conclusão da implantação, selecione Fixar no painel, que cria um bloco para esse serviço no painel do portal do Azure como um atalho para a página de Visão geral do serviço.

   

6. Selecione Ir para o recurso para ir para a página Visão geral dos Aplicativos Spring do Azure.

3.3. Preparar a instância do PostgreSQL

Use as etapas a seguir para criar um servidor do Banco de Dados do Azure para PostgreSQL:

1. Vá para o portal do Azure e selecione Criar um recurso.

2. Selecione Bancos de Dados>Banco de Dados do Azure para PostgreSQL.

3. Selecione a opção de implantação Servidor flexível.

   

4. Preencha a guia Básico com as seguintes informações:

   • Nome do servidor: my-demo-pgsql
   • Região: Leste dos EUA
   • Versão do PostgreSQL: 14
   • Tipo de carga de trabalho: Desenvolvimento
   • Habilitar alta disponibilidade: não selecionado
   • Método de autenticação: somente autenticação PostgreSQL
   • Nome de usuário do administrador: myadmin
   • Senha e Confirmar senha: Insira uma senha.

5. Use as seguintes informações para configurar a guia Rede:

   • Método de conectividade: Acesso público (endereços IP permitidos)
   • Permitir acesso público de qualquer serviço do Azure a este servidor: selecionado

6. Selecione Examinar + criar para examinar suas seleções e, em seguida, selecione Criar para provisionar o servidor. Essa operação poderá levar alguns minutos.

7. Acesse o servidor PostgreSQL no portal do Azure. Na página Visão geral, procure o valor do nome do servidor e registre-o para uso posterior. Você precisa dele para configurar as variáveis de ambiente para o aplicativo nos Aplicativos Spring do Azure.

8. Selecione Bancos de dados no menu de navegação para criar um banco de dados, por exemplo, todo.

   

3.4. Conectar a instância de aplicativo à instância do PostgreSQL

Use as etapas a seguir para conectar as instâncias de serviço:

1. Vá para a sua instância do Azure Spring Apps no portal do Azure.

2. No menu de navegação, abra Aplicativos e selecione Criar Aplicativo.

3. Na página Criar aplicativo, preencha o nome do aplicativo como simple-todo-api e selecione Artefatos Java como o tipo de implantação.

4. Selecione Criar para concluir a criação do aplicativo e selecione o aplicativo para exibir os detalhes.

5. Acesse o aplicativo que você criou no portal do Azure. Na página Visão geral, selecione Atribuir ponto de extremidade para expor o ponto de extremidade público do aplicativo. Salve a URL para acessar o aplicativo após a implantação.

6. Selecione Conector de serviço no painel de navegação e selecione Criar para criar uma nova conexão de serviço.

   

7. Preencha a guia Básico com as seguintes informações:

   • Tipo de serviço: servidor flexível do BD para PostgreSQL
   • Nome da conexão: um nome gerado automaticamente é preenchido e ele também pode ser modificado.
   • Assinatura: Selecione sua assinatura.
   • Servidor flexível do PostgreSQL: my-demo-pgsql
   • Banco de dados PostgreSQL: selecione o banco de dados criado por você.
   • Tipo de cliente: SpringBoot

   

8. Configure a guia Próximo: autenticação com as seguintes informações:

   • Selecione o tipo de autenticação que você gostaria de usar entre o serviço de computação e o serviço de destino: selecione Cadeia de conexão.
   • Continuar com...: selecione Credenciais do banco de dados
   • Nome de usuário: myadmin
   • Senha: insira a senha.

   

9. Selecione Avançar: Rede. Use a opção padrão Configurar regras de firewall para habilitar o acesso ao serviço de destino.

10. Selecione Próximo: examinar e criar para examinar suas seleções e, em seguida, selecione Criar para criar a conexão.

3.5. Expor APIs RESTful

Use as seguintes etapas para expor suas APIs RESTful no Microsoft Entra ID:

1. Entre no portal do Azure.

2. Se você tiver acesso a vários locatários, use o filtro Diretório + assinatura () para selecionar o locatário no qual quer registrar um aplicativo.

3. Pesquise e selecione Microsoft Entra ID.

4. Em Gerenciar, selecione Registros de aplicativo>Novo registro.

5. Insira um nome para seu aplicativo no campo Nome, por exemplo, Todo. Os usuários do seu aplicativo podem ver esse nome e você pode alterá-lo mais tarde.

6. Em Tipos de conta com suporte, selecione Contas em qualquer diretório da organização (qualquer diretório do Microsoft Entra — com vários locatários) e contas Microsoft pessoais.

7. Selecione Registrar para criar o aplicativo.

8. Na página Visão Geral do aplicativo, localize o valor da ID do aplicativo (cliente) e registre-o para uso posterior. Você precisa dele para configurar o arquivo de configuração YAML para este projeto.

9. Em Gerenciar, selecione Expor uma API, localize o URI de ID do aplicativo no início da página e selecione Adicionar.

10. Na página Editar URI do ID do aplicativo, aceite o URI do ID do aplicativo proposto (api://{client ID}) ou use um nome significativo em vez do ID do cliente, como api://simple-todo, e selecione Salvar.

11. Em Gerenciar, selecione Expor uma API>Adicionar um escopo e, em seguida, insira as seguintes informações:

    • Para o nome do escopo, insira ToDo.Read.
    • Para Quem pode consentir?: selecione somente administradores.
    • Para o nome de exibição de consentimento do administrador, insira Ler os dados de ToDo.
    • Para descrição de consentimento do administrador, insira Permitir que os usuários autenticados leiam os dados do ToDo..
    • Para Estado, mantenha-o habilitado.
    • Selecione Adicionar escopo.

12. Repita as etapas anteriores para adicionar os dois outros escopos: ToDo.Write e ToDo.Delete.

    

3.6. Atualizar a configuração do aplicativo

Use as seguintes etapas para atualizar o arquivo YAML para usar suas informações de aplicativo registrado do Microsoft Entra e estabelecer uma relação com o aplicativo de API RESTful:

1. Localize o arquivo src/main/resources/application.yml para o aplicativo simple-todo-api. Atualize a configuração na seção spring.cloud.azure.active-directory para corresponder ao exemplo a seguir. Substitua os espaços reservados pelos valores criados anteriormente.

   spring:
     cloud:
       azure:
         active-directory:
           profile:
             tenant-id: <tenant>
           credential:
             client-id: <your-application-ID-of-ToDo>
           app-id-uri: <your-application-ID-URI-of-ToDo>
   

   Observação

   Em tokens v1.0, a configuração requer a ID do cliente da API, enquanto em tokens v2.0, você pode usar a ID do cliente ou o URI da ID do aplicativo na solicitação. Você pode configurar ambos para concluir corretamente a validação do público-alvo.

   Os valores permitidos para tenant-id são: common, organizations, consumers ou a ID do locatário. Para obter mais informações sobre esses valores, consulte a seção Uso do ponto de extremidade incorreto (contas pessoais e de organização) do Error AADSTS50020 – A conta de usuário do provedor de identidade não existe no locatário. Para saber como converter seu aplicativo de locatário único, consulte Converter aplicativo de locatário único em multilocatário no Microsoft Entra ID.

2. Use o comando a seguir para recompilar o projeto de exemplo:

   ./mvnw clean package
   

CLI do Azure

3.1. Fornecer nomes para cada recurso

Crie variáveis para manter os nomes dos recursos usando os comandos a seguir. Substitua os espaços reservados pelos seus valores.

export RESOURCE_GROUP=myresourcegroup
export LOCATION=<location>
export POSTGRESQL_SERVER=my-demo-pgsql
export POSTGRESQL_DB=Todo
export POSTGRESQL_ADMIN_USERNAME=<admin-username>
export POSTGRESQL_ADMIN_PASSWORD=<admin-password>
export AZURE_SPRING_APPS_NAME=myasa
export APP_NAME=simple-todo-api
export TODO_APP_NAME=Todo
export TODO_APP_URL=api://simple-todo
export TODOWEB_APP_NAME=TodoWeb
export TODOWEB_APP_URL=api://simple-todoweb
export NEW_MEMBER_USERNAME=<new-member-username>
export NEW_MEMBER_PASSWORD=<new-member-password>
export USER_PRINCIPAL_NAME=<user-principal-name>

3.2. Criar um novo grupo de recursos

Use as etapas a seguir para criar um novo grupo de recursos:

1. Use o seguinte comando para fazer logon na CLI do Azure:

   az login
   

2. Use o seguinte comando para definir o local padrão:

   az configure --defaults location=${LOCATION}
   

3. Use o comando a seguir para listar todas as assinaturas disponíveis e determinar a ID de assinatura a ser usada:

   az account list --output table
   

4. Use o comando a seguir para definir a assinatura padrão:

   az account set --subscription <subscription-ID>
   

5. Use o comando a seguir para criar um grupo de recursos:

   az group create --resource-group ${RESOURCE_GROUP}
   

6. Use o seguinte comando para definir o grupo de recursos recém-criado como o grupo de recursos padrão:

   az configure --defaults group=${RESOURCE_GROUP}
   

3.3. Instalar a extensão e registrar o namespace

Use os seguintes comandos para instalar a extensão dos Aplicativos Spring do Azure para a CLI do Azure e registrar o namespaces Microsoft.SaaS:

az extension add --name spring --upgrade
az provider register --namespace Microsoft.SaaS

3.4. Criar uma instância do Azure Spring Apps

Use as seguintes etapas para criar uma instância de serviço e um aplicativo na instância:

1. Use o comando a seguir para aceitar os termos legais e as declarações de privacidade do plano Enterprise:

   Observação

   Essa etapa só será necessária se sua assinatura nunca tiver sido usada para criar uma instância do plano Enterprise dos Aplicativos Spring do Azure.

   az term accept \
       --publisher vmware-inc \
       --product azure-spring-cloud-vmware-tanzu-2 \
       --plan asa-ent-hr-mtr
   

2. Use o seguinte comando para criar uma instância de serviço de Aplicativos Spring do Azure:

   az spring create --name ${AZURE_SPRING_APPS_NAME} --sku enterprise
   

3. Use o seguinte comando para criar um aplicativo na instância dos Aplicativos Spring do Azure:

   az spring app create \
       --service ${AZURE_SPRING_APPS_NAME} \
       --name ${APP_NAME} \
       --assign-endpoint true
   

3.5. Preparar a instância do PostgreSQL

O aplicativo Web Spring usa H2 para o banco de dados no localhost e Banco de Dados do Azure para PostgreSQL para o banco de dados no Azure.

Use o seguinte comando para criar uma instância do PostgreSQL:

az postgres flexible-server create \
    --name ${POSTGRESQL_SERVER} \
    --database-name ${POSTGRESQL_DB} \
    --admin-user ${POSTGRESQL_ADMIN_USERNAME} \
    --admin-password ${POSTGRESQL_ADMIN_PASSWORD} \
    --public-access 0.0.0.0

Especificar 0.0.0.0 permite o acesso público de todos os recursos implantados no Azure para acessar o servidor.

3.6. Conectar a instância de aplicativo à instância do PostgreSQL

Depois que a instância de aplicativo e a instância do PostgreSQL forem criadas, a instância de aplicativo não poderá acessar a instância do PostgreSQL diretamente. Use as etapas a seguir para permitir que o aplicativo se conecte à instância do PostgreSQL:

1. Use o comando a seguir para obter o nome de domínio totalmente qualificado da instância do PostgreSQL:

   export PSQL_FQDN=$(az postgres flexible-server show \
       --name ${POSTGRESQL_SERVER} \
       --query fullyQualifiedDomainName \
       --output tsv)
   

2. Use o comando a seguir para fornecer as propriedades de spring.datasource. ao aplicativo por meio de variáveis de ambiente:

   az spring app update \
       --service ${AZURE_SPRING_APPS_NAME} \
       --name ${APP_NAME} \
       --env SPRING_DATASOURCE_URL="jdbc:postgresql://${PSQL_FQDN}:5432/${POSTGRESQL_DB}?sslmode=require" \
             SPRING_DATASOURCE_USERNAME="${POSTGRESQL_ADMIN_USERNAME}" \
             SPRING_DATASOURCE_PASSWORD="${POSTGRESQL_ADMIN_PASSWORD}"
   

3.7. Expor APIs RESTful

Use as seguintes etapas para expor as APIs RESTful:

1. Use o seguinte comando para criar um aplicativo do Microsoft Entra ID:

   az ad app create \
       --display-name ${TODO_APP_NAME} \
       --sign-in-audience AzureADandPersonalMicrosoftAccount \
       --identifier-uris ${TODO_APP_URL}
   

2. Use o seguinte comando para criar uma entidade de serviço para o aplicativo:

   az ad sp create --id ${TODO_APP_URL}
   

3. Use o seguinte comando para gerar as IDs de permissão:

   permissionid1=$(uuidgen);permissionid2=$(uuidgen);permissionid3=$(uuidgen)
   

4. Adicione os seguintes escopos como JSON：

   api=$(echo '{
    "oauth2PermissionScopes": [
        {
            "adminConsentDescription": "Allows authenticated users to delete the ToDo data",
            "adminConsentDisplayName": "Delete the ToDo data",
            "id": "'$permissionid1'",
            "isEnabled": true,
            "type": "Admin",
            "userConsentDescription": null,
            "userConsentDisplayName": null,
            "value": "ToDo.Delete"
        },
   
        {
            "adminConsentDescription": "Allows authenticated users to write the ToDo data",
            "adminConsentDisplayName": "Write the ToDo data",
            "id": "'$permissionid2'",
            "isEnabled": true,
            "type": "Admin",
            "userConsentDescription": null,
            "userConsentDisplayName": null,
            "value": "ToDo.Write"
        },
        {
            "adminConsentDescription": "Allows authenticated users to read the ToDo data",
            "adminConsentDisplayName": "Read the ToDo data",
            "id": "'$permissionid3'",
            "isEnabled": true,
            "type": "Admin",
            "userConsentDescription": null,
            "userConsentDisplayName": null,
            "value": "ToDo.Read"
        }
    ]}')
   

5. Use o seguinte comando para adicionar escopos:

   az ad app update \
       --id ${TODO_APP_URL} \
       --set api="$api"
   

6. Use o seguinte comando para obter a ID do locatário a ser usada na próxima etapa:

   az account show --query "tenantId" --output tsv
   

7. Use o seguinte comando para obter a ID do aplicativo a ser usada nas próximas etapas:

   appid=$(az ad app show \
       --id ${TODO_APP_URL} \
       --query appId \
       --output tsv);
   echo $appid
   

3.8. Atualizar a configuração do aplicativo

Use as seguintes etapas para atualizar o arquivo YAML para usar suas informações de aplicativo registrado do Microsoft Entra e estabelecer uma relação com o aplicativo de API RESTful:

1. Localize o arquivo src/main/resources/application.yml para o aplicativo simple-todo-api. Atualize a configuração na seção spring.cloud.azure.active-directory para corresponder ao exemplo a seguir. Substitua os espaços reservados pelos valores criados anteriormente.

   spring:
     cloud:
       azure:
         active-directory:
           profile:
             tenant-id: <tenant>
           credential:
             client-id: <your-application-ID-of-ToDo>
           app-id-uri: <your-application-ID-URI-of-ToDo>
   

   Observação

   Em tokens v1.0, a configuração requer a ID do cliente da API, enquanto em tokens v2.0, você pode usar a ID do cliente ou o URI da ID do aplicativo na solicitação. Você pode configurar ambos para concluir corretamente a validação do público-alvo.

   Os valores permitidos para tenant-id são: common, organizations, consumers ou a ID do locatário. Para obter mais informações sobre esses valores, consulte a seção Uso do ponto de extremidade incorreto (contas pessoais e de organização) do Error AADSTS50020 – A conta de usuário do provedor de identidade não existe no locatário. Para saber como converter seu aplicativo de locatário único, consulte Converter aplicativo de locatário único em multilocatário no Microsoft Entra ID.

2. Use o comando a seguir para recompilar o projeto de exemplo:

   ./mvnw clean package
   

4. Implantar o aplicativo em Aplicativos Spring do Azure

Portal do Azure + plug-in do Maven

Agora você pode implantar o aplicativo em Aplicativos Spring do Azure.

Use as etapas a seguir para implantar usando o plug-in Maven para Aplicativos Spring do Azure:

1. Navegue até o diretório completo e execute o seguinte comando para configurar o aplicativo em Aplicativos Spring do Azure:

   ./mvnw com.microsoft.azure:azure-spring-apps-maven-plugin:1.19.0:config
   

   A lista a seguir descreve as interações de comando:

   • Logon do OAuth2: autorize a entrada no Azure com base no protocolo OAuth2.
   • Selecionar assinatura: selecione o número da lista de assinaturas da instância dos Aplicativos Spring do Azure que você criou, que usa como padrão a primeira assinatura na lista. Se você usar o número padrão, pressione Enter diretamente.
   • Usar o Aplicativos Spring do Azure existente: pressione S para usar a instância existente do Aplicativos Spring do Azure.
   • Selecionar os Aplicativos Spring do Azure para implantação: selecione o número da instância dos Aplicativos Spring do Azure que você criou. Se você usar o número padrão, pressione Enter diretamente.
   • Use o aplicativo existente no Aplicativos Spring do Azure <nome da sua instância>: pressione S para usar o aplicativo criado.
   • Confirme para salvar todas as configurações acima: pressione S. Se você pressionar n, a configuração não será salva nos arquivos POM.

2. Use o seguinte comando para implantar o aplicativo:

   ./mvnw azure-spring-apps:deploy
   

   A lista a seguir descreve a interação de comando:

   • Logon do OAuth2: autorize a entrada no Azure com base no protocolo OAuth2.

   Depois que o comando for executado, você poderá pelas mensagens de log que a implantação foi bem-sucedida:

[INFO] Deployment Status: Running
[INFO]   InstanceName:simple-todo-api-default-15-xxxxxxxxx-xxxxx  Status:Running Reason:null       DiscoverStatus:N/A       
[INFO] Getting public url of app(simple-todo-api)...
[INFO] Application url: https://<your-Azure-Spring-Apps-instance-name>-simple-todo-api.azuremicroservices.io

CLI do Azure

Use o seguinte comando para implantar o aplicativo com base no código-fonte:

az spring app deploy \
    --service ${AZURE_SPRING_APPS_NAME} \
    --name ${APP_NAME} \
    --build-env BP_JVM_VERSION=17 \
    --source-path .

5. Validar os aplicativos

Portal do Azure + plug-in do Maven

Agora, você pode acessar a API RESTful para conferir se ela funciona.

5.1. Solicitar um token de acesso

As APIs RESTful atuam como um servidor de recursos, que é protegido pelo Microsoft Entra ID. Antes de adquirir um token de acesso, você deverá registrar outro aplicativo no Microsoft Entra ID e conceder permissões ao aplicativo cliente, que é chamado ToDoWeb.

Registrar o aplicativo cliente

Use as seguintes etapas para registrar um aplicativo no Microsoft Entra ID, que é usado para adicionar as permissões para o aplicativo ToDo:

1. Entre no portal do Azure.

2. Se você tiver acesso a vários locatários, use o filtro Diretório + assinatura () para selecionar o locatário no qual quer registrar um aplicativo.

3. Pesquise e selecione Microsoft Entra ID.

4. Em Gerenciar, selecione Registros de aplicativo>Novo registro.

5. Insira um nome para seu aplicativo no campo Nome – por exemplo, ToDoWeb. Os usuários do seu aplicativo podem ver esse nome e você pode alterá-lo mais tarde.

6. Para tipos de conta com suporte, use o valor padrão Contas somente neste diretório organizacional.

7. Selecione Registrar para criar o aplicativo.

8. Na página Visão Geral do aplicativo, localize o valor da ID do aplicativo (cliente) e registre-o para uso posterior. Isso será necessário para adquirir um token de acesso.

9. Selecione Permissões de API>Adicionar uma permissão>Minhas APIs. Selecione o aplicativo ToDo que você registrou anteriormente e, em seguida, selecione as permissões ToDo.Read, ToDo.Writee ToDo.Delete. Selecione Adicionar permissões.

10. Selecione Conceder consentimento do administrador< para >your-tenant-name para conceder o consentimento do administrador para as permissões adicionadas.

    

Adicionar usuário para acessar as APIs RESTful

Use as etapas a seguir para criar um usuário membro em seu locatário do Microsoft Entra. Em seguida, o usuário pode gerenciar os dados do aplicativo por meio de APIs RESTful ToDo.

1. Em Gerenciar, selecione Usuários>Novo usuário>Criar novo usuário.

2. Na página Criar novo usuário, insira as seguintes informações:

   • Nome da entidade de usuário: insira um nome para o usuário.
   • Nome de exibição: insira um nome de exibição para o usuário.
   • Senha: copie a senha gerada automaticamente fornecida na caixa Senha.

   Observação

   Os novos usuários devem concluir a primeira autenticação de entrada e atualizar suas senhas, caso contrário, você receberá um erro AADSTS50055: The password is expired ao obter o token de acesso.

   Quando um novo usuário faz logon, ele recebe um prompt de Ação Necessária. Eles podem escolher Pedir mais tarde para ignorar a validação.

3. Selecione Revisar + criar para revisar suas seleções. Selecione Criar para criar o usuário.

Atualizar a configuração do OAuth2 para autorização da interface do usuário do Swagger

Use as etapas a seguir para atualizar a configuração do OAuth2 para autorização da interface do usuário do Swagger. Em seguida, você pode autorizar os usuários a adquirir tokens de acesso por meio do aplicativo ToDoWeb.

1. Abra o locatário do Microsoft Entra ID no portal do Azure e acesse o aplicativo registrado ToDoWeb.

2. Em Gerenciar, selecione Autenticação, Selecione Adicionar uma plataforma e selecione Aplicativo de página única.

3. Use o formato <your-app-exposed-application-URL-or-endpoint>/swagger-ui/oauth2-redirect.html como a URL de redirecionamento OAuth2 no campo Redirecionamento de URIs e selecione Configurar.

   

CLI do Azure

Agora, você pode acessar a API RESTful para conferir se ela funciona.

5.1. Solicitar um token de acesso

As APIs RESTful atuam como um servidor de recursos, que é protegido pelo Microsoft Entra ID. Antes de adquirir um token de acesso, é necessário registrar outro aplicativo no Microsoft Entra ID e conceder permissões ao aplicativo cliente, que é chamado ToDoWeb.

Registrar o aplicativo cliente

Use as seguintes etapas para registrar o aplicativo cliente:

1. Use o seguinte comando para criar um aplicativo do Microsoft Entra ID, que é usado para adicionar as permissões para o aplicativo ToDo:

   az ad app create \
       --display-name ${TODOWEB_APP_NAME} \
       --sign-in-audience AzureADMyOrg \
       --identifier-uris ${TODOWEB_APP_URL}
   

2. Use o seguinte comando para adicionar permissões:

   az ad app permission add \
       --id api://simple-todowebtest2 \
       --api $appid \
       --api-permissions $permissionid1=Scope $permissionid2=Scope $permissionid3=Scope
   

3. Use o seguinte comando para permitir consentimento do administrador para as permissões que você adicionou:

   az ad app permission admin-consent --id ${TODOWEB_APP_URL}
   

4. Use o seguinte comando para obter a ID do cliente do aplicativo ToDoWeb usada na etapa Obter o token de acesso:

   az ad app show \
       --id ${TODOWEB_APP_URL} \
       --query appId \
       --output tsv
   

Adicionar usuário para acessar as APIs RESTful

Use o comando a seguir para criar um usuário membro em seu locatário do Microsoft Entra. Em seguida, o usuário pode gerenciar os dados do aplicativo por meio de APIs RESTful ToDo:

az ad user create \
    --display-name ${NEW_MEMBER_USERNAME} \
    --password ${NEW_MEMBER_PASSWORD} \
    --user-principal-name ${USER_PRINCIPAL_NAME}

Atualizar a configuração do OAuth2 para autorização da interface do usuário do Swagger

Use as seguintes etapas para atualizar a configuração do OAuth2:

1. Use o seguinte comando para obter a ID do objeto do aplicativo ToDoWeb:

   az ad app show --id ${TODOWEB_APP_URL} --query id
   

2. Use o seguinte comando para obter o URL do aplicativo simple-todo-api:

   az spring app show \
       --name ${APP_NAME} \
       --service ${AZURE_SPRING_APPS_NAME} \
       --query properties.url
   

3. Use o seguinte comando para atualizar a configuração do OAuth2 para autorização da interface do usuário do Swagger, substituindo os espaços reservados <object-id> e <URL> com os valores de parâmetro obtidos. Em seguida, você pode autorizar os usuários a adquirir tokens de acesso por meio do aplicativo ToDoWeb.

   az rest \
       --method PATCH \
       --uri "https://graph.microsoft.com/v1.0/applications/<object-id>" \
       --headers 'Content-Type=application/json' \
       --body '{"spa":{"redirectUris":["<URL>/swagger-ui/oauth2-redirect.html"]}}'
   

2. Preparar o projeto Spring

Para implantar o aplicativo de API RESTful, a primeira etapa é preparar o projeto Spring para ser executado localmente.

Portal do Azure + plug-in do Maven

Use as etapas a seguir para clonar e executar o aplicativo localmente:

1. Use o seguinte comando para clonar o projeto de exemplo do GitHub:

   git clone https://github.com/Azure-Samples/ASA-Samples-Restful-Application.git
   

2. Se você quiser executar o aplicativo localmente, conclua as etapas nas seções Expor RESTful APIs e Atualizar configuração do aplicativo primeiro e use o seguinte comando para executar o aplicativo de exemplo com o Maven:

   cd ASA-Samples-Restful-Application
   ./mvnw spring-boot:run
   

CLI do Desenvolvedor do Azure

Use as etapas a seguir para inicializar o aplicativo Web a partir dos modelos do Azure Developer CLI:

1. Abra um terminal, crie uma nova pasta vazia e altere o diretório para ela.

2. Execute o seguinte comando para inicializar o projeto:

   azd init --template Azure-Samples/ASA-Samples-Restful-Application
   

   A lista a seguir descreve as interações de comando:

   • Logon do OAuth2: é necessário autorizar a entrada no Azure com base no protocolo OAuth2.
   • Insira um novo nome de ambiente: forneça um nome de ambiente. Esse nome é usado como um sufixo para o grupo de recursos criado para armazenar todos os recursos do Azure. Esse nome deve ser exclusivo em sua assinatura do Azure.

   O console gera mensagens semelhantes ao exemplo a seguir:

   Initializing a new project (azd init)
   
   Downloading template code to: <your-local-path>
   (✓) Done: Initialized git repository
   
   Enter a new environment name: <your-env-name>
   
   SUCCESS: New project initialized!
   You can view the template code in your directory: <your-local-path>
   Learn more about running 3rd party code on our DevHub: https://aka.ms/azd-third-party-code-notice
   

3. Preparar o ambiente de nuvem

Os principais recursos necessários para executar esse aplicativo de exemplo são uma instância dos Aplicativos Spring do Azure e uma instância do Banco de Dados do Azure para PostgreSQL. As seções a seguir descrevem como criar esses recursos.

Portal do Azure + plug-in do Maven

3.1. Entre no Portal do Azure

Acesse o portal do Azure e insira suas credenciais para entrar no portal. A exibição padrão é o painel de serviço.

3.2. Criar uma instância do Azure Spring Apps

Use as etapas a seguir para criar uma instância de serviço:

1. Selecione Criar um recurso no canto do portal.

2. Selecione Computação>Aplicativos Spring do Azure.

3. Preencha o formulário Noções básicas. Use a tabela a seguir como um guia para concluir o formulário. O valor de Plano recomendado é Consumo padrão e dedicado (versão prévia).

   Configuração	Valor sugerido	Descrição
   Assinatura	O nome da sua assinatura.	A assinatura do Azure que você deseja usar para o servidor. Caso você tenha várias assinaturas, escolha a assinatura na qual você deseja receber a cobrança do recurso.
   Grupo de recursos	myresourcegroup	Um novo nome do grupo de recursos ou um existente de sua assinatura.
   Nome	myasa	Um nome exclusivo que identifica o serviço Aplicativos Spring do Azure. O nome deve ter entre 4 e 32 caracteres e pode conter apenas letras minúsculas, números e hifens. O primeiro caractere do nome do serviço deve ser uma letra e o último caractere deve ser uma letra ou um número.
   Plano	Consumo padrão e dedicado (versão prévia)	O plano de preços determina os recursos e o custo associados à sua instância.
   Região	A região mais próxima de seus usuários.	A localização mais próxima dos usuários.
   Ambiente de aplicativos de Contêiner	myenvironment	A opção para selecionar qual instância do ambiente de Aplicativos de Contêiner deve compartilhar a mesma rede virtual com outros serviços e recursos.

   Use a tabela a seguir como um guia para a criação do ambiente de Aplicativos de Contêiner:

   Configuração	Valor sugerido	Descrição
   Nome do ambiente	myenvironment	Um nome exclusivo que identifica seu serviço do Ambiente de Aplicativos de Contêiner do Azure.
   Plano	Consumo	O plano de preços determina os recursos e o custo associados à sua instância.
   Com Redundância de Zona	Desabilitadas	A opção para criar um serviço de Ambiente de Aplicativos de Contêiner em uma zona de disponibilidade do Azure.

4. Selecione Revisar e criar para revisar suas seleções. Em seguida, selecione Criar para provisionar a instância dos Aplicativos Spring do Azure.

5. Na barra de ferramentas, selecione o ícone (sino) Notificações para monitorar o processo de implantação. Após a conclusão da implantação, selecione Fixar no painel, que cria um bloco para esse serviço no painel do portal do Azure como um atalho para a página de Visão geral do serviço.

6. Selecione Ir para o recurso para abrir a página Visão geral do serviço.

   

Importante

O perfil de carga de trabalho de Consumo tem um modelo de cobrança pré-paga, sem custo inicial. Você é cobrado pelo perfil de carga de trabalho dedicado com base nos recursos provisionados. Para obter mais informações, consulte perfis de carga de trabalho nos Aplicativos de Contêiner do Azure e preços dos Aplicativos Spring do Azure.

3.3. Preparar a instância do PostgreSQL

Use as etapas a seguir para criar um servidor do Banco de Dados do Azure para PostgreSQL:

1. Vá para o portal do Azure e selecione Criar um recurso.

2. Selecione Bancos de Dados>Banco de Dados do Azure para PostgreSQL.

3. Selecione a opção de implantação Servidor flexível.

   

4. Preencha a guia Básico com as seguintes informações:

   • Nome do servidor: my-demo-pgsql
   • Região: Leste dos EUA
   • Versão do PostgreSQL: 14
   • Tipo de carga de trabalho: Desenvolvimento
   • Habilitar alta disponibilidade: não selecionado
   • Método de autenticação: somente autenticação PostgreSQL
   • Nome de usuário do administrador: myadmin
   • Senha e Confirmar senha: Insira uma senha.

5. Use as seguintes informações para configurar a guia Rede:

   • Método de conectividade: Acesso público (endereços IP permitidos)
   • Permitir acesso público de qualquer serviço do Azure a este servidor: selecionado

6. Selecione Examinar + criar para examinar suas seleções e, em seguida, selecione Criar para provisionar o servidor. Essa operação poderá levar alguns minutos.

7. Acesse o servidor PostgreSQL no portal do Azure. Na página Visão geral, procure o valor do nome do servidor e registre-o para uso posterior. Você precisa dele para configurar as variáveis de ambiente para o aplicativo nos Aplicativos Spring do Azure.

8. Selecione Bancos de dados no menu de navegação para criar um banco de dados, por exemplo, todo.

   

3.4. Conectar a instância de aplicativo à instância do PostgreSQL

Use as etapas a seguir para conectar as instâncias de serviço:

1. Vá para a sua instância do Azure Spring Apps no portal do Azure.

2. No menu de navegação, abra Aplicativos e selecione Criar Aplicativo.

3. Na página Criar Aplicativo, preencha o nome do aplicativo simple-todo-api e selecione artefatos Java como o tipo de implantação.

4. Selecione Criar para concluir a criação do aplicativo e selecione o aplicativo para exibir os detalhes.

5. Acesse o aplicativo que você criou no portal do Azure. Na página Visão geral, selecione Atribuir ponto de extremidade para expor o ponto de extremidade público do aplicativo. Salve a URL para acessar o aplicativo após a implantação.

6. Acesse o aplicativo criado, expanda Configurações e selecione Configuração no menu de navegação e Variáveis de ambiente para definir as variáveis de ambiente.

7. Adicione as variáveis de ambiente a seguir para a conexão PostgreSQL e selecione Salvar para concluir a atualização de configuração do aplicativo. Substitua os espaços reservados por seus próprios valores criados anteriormente.

   Variável de ambiente	Valor
   SPRING_DATASOURCE_URL	jdbc:postgresql://<your-PostgreSQL-server-name>:5432/<your-PostgreSQL-database-name>
   SPRING_DATASOURCE_USERNAME	<your-PostgreSQL-admin-user>
   SPRING_DATASOURCE_PASSWORD	<your-PostgreSQL-admin-password>

   

3.5. Expor APIs RESTful

Use as seguintes etapas para expor suas APIs RESTful no Microsoft Entra ID:

1. Entre no portal do Azure.

2. Se você tiver acesso a vários locatários, use o filtro Diretório + assinatura () para selecionar o locatário no qual quer registrar um aplicativo.

3. Pesquise e selecione Microsoft Entra ID.

4. Em Gerenciar, selecione Registros de aplicativo>Novo registro.

5. Insira um nome para seu aplicativo no campo Nome, por exemplo, Todo. Os usuários do seu aplicativo podem ver esse nome e você pode alterá-lo mais tarde.

6. Em Tipos de conta com suporte, selecione Contas em qualquer diretório da organização (qualquer diretório do Microsoft Entra — com vários locatários) e contas Microsoft pessoais.

7. Selecione Registrar para criar o aplicativo.

8. Na página Visão Geral do aplicativo, localize o valor da ID do aplicativo (cliente) e registre-o para uso posterior. Você precisa dele para configurar o arquivo de configuração YAML para este projeto.

9. Em Gerenciar, selecione Expor uma API, localize o URI de ID do aplicativo no início da página e selecione Adicionar.

10. Na página Editar URI do ID do aplicativo, aceite o URI do ID do aplicativo proposto (api://{client ID}) ou use um nome significativo em vez do ID do cliente, como api://simple-todo, e selecione Salvar.

11. Em Gerenciar, selecione Expor uma API>Adicionar um escopo e, em seguida, insira as seguintes informações:

    • Para o nome do escopo, insira ToDo.Read.
    • Para Quem pode consentir?: selecione somente administradores.
    • Para o nome de exibição de consentimento do administrador, insira Ler os dados de ToDo.
    • Para descrição de consentimento do administrador, insira Permitir que os usuários autenticados leiam os dados do ToDo..
    • Para Estado, mantenha-o habilitado.
    • Selecione Adicionar escopo.

12. Repita as etapas anteriores para adicionar os dois outros escopos: ToDo.Write e ToDo.Delete.

    

3.6. Atualizar a configuração do aplicativo

Use as seguintes etapas para atualizar o arquivo YAML para usar suas informações de aplicativo registrado do Microsoft Entra e estabelecer uma relação com o aplicativo de API RESTful:

1. Localize o arquivo src/main/resources/application.yml para o aplicativo simple-todo-api. Atualize a configuração na seção spring.cloud.azure.active-directory para corresponder ao exemplo a seguir. Substitua os espaços reservados pelos valores criados anteriormente.

   spring:
     cloud:
       azure:
         active-directory:
           profile:
             tenant-id: <tenant>
           credential:
             client-id: <your-application-ID-of-ToDo>
           app-id-uri: <your-application-ID-URI-of-ToDo>
   

   Observação

   Em tokens v1.0, a configuração requer a ID do cliente da API, enquanto em tokens v2.0, você pode usar a ID do cliente ou o URI da ID do aplicativo na solicitação. Você pode configurar ambos para concluir corretamente a validação do público-alvo.

   Os valores permitidos para tenant-id são: common, organizations, consumers ou a ID do locatário. Para obter mais informações sobre esses valores, consulte a seção Uso do ponto de extremidade incorreto (contas pessoais e de organização) do Error AADSTS50020 – A conta de usuário do provedor de identidade não existe no locatário. Para saber como converter seu aplicativo de locatário único, consulte Converter aplicativo de locatário único em multilocatário no Microsoft Entra ID.

2. Use o comando a seguir para recompilar o projeto de exemplo:

   ./mvnw clean package
   

CLI do Desenvolvedor do Azure

3.1. Preparar os recursos do Azure

Use as seguintes etapas para provisionar os recursos necessários do Azure:

1. Execute o seguinte comando para fazer logon no Azure com o OAuth2. Ignore esta etapa se você já tiver feito o logon.

   azd auth login
   

2. Execute o seguinte comando para instalar o recurso do Aplicativos Spring do Azure:

   azd config set alpha.springapp on
   

3. Execute o seguinte comando para empacotar uma cópia implantável do aplicativo, provisionar a infraestrutura do modelo no Azure e implantar o código do aplicativo nesses recursos recém-provisionados:

   azd provision
   

   A lista a seguir descreve as interações de comando:

   • Selecione uma assinatura do Azure para usar: use as setas para mover, digite para filtrar e pressione Enter.
   • Selecione um local do Azure para usar: use as setas para mover, digite para filtrar e pressione Enter.

   O console gera mensagens semelhantes ao exemplo a seguir:

   SUCCESS: Your application was provisioned in Azure in xx minutes xx seconds.
   You can view the resources created under the resource group rg-<your-environment-name>> in Azure Portal:
   https://portal.azure.com/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/<your-resource-group>/overview
   

   Observação

   Esse comando pode demorar algum tempo para ser concluído. Você verá um indicador de progresso ao provisionar recursos do Azure.

3.2. Expor APIs RESTful

Use as seguintes etapas para expor suas APIs RESTful no Microsoft Entra ID:

1. Entre no portal do Azure.

2. Se você tiver acesso a vários locatários, use o filtro Diretório + assinatura () para selecionar o locatário no qual quer registrar um aplicativo.

3. Pesquise e selecione Microsoft Entra ID.

4. Em Gerenciar, selecione Registros de aplicativo>Novo registro.

5. Insira um nome para seu aplicativo no campo Nome, por exemplo, Todo. Os usuários do seu aplicativo podem ver esse nome e você pode alterá-lo mais tarde.

6. Em Tipos de conta com suporte, selecione Contas em qualquer diretório da organização (qualquer diretório do Microsoft Entra — com vários locatários) e contas Microsoft pessoais.

7. Selecione Registrar para criar o aplicativo.

8. Na página Visão Geral do aplicativo, localize o valor da ID do aplicativo (cliente) e registre-o para uso posterior. Você precisa dele para configurar o arquivo de configuração YAML para este projeto.

9. Em Gerenciar, selecione Expor uma API, localize o URI de ID do aplicativo no início da página e selecione Adicionar.

10. Na página Editar URI do ID do aplicativo, aceite o URI do ID do aplicativo proposto (api://{client ID}) ou use um nome significativo em vez do ID do cliente, como api://simple-todo, e selecione Salvar.

11. Em Gerenciar, selecione Expor uma API>Adicionar um escopo e, em seguida, insira as seguintes informações:

    • Para o nome do escopo, insira ToDo.Read.
    • Para Quem pode consentir?: selecione somente administradores.
    • Para o nome de exibição de consentimento do administrador, insira Ler os dados de ToDo.
    • Para descrição de consentimento do administrador, insira Permitir que os usuários autenticados leiam os dados do ToDo..
    • Para Estado, mantenha-o habilitado.
    • Selecione Adicionar escopo.

12. Repita as etapas anteriores para adicionar os dois outros escopos: ToDo.Write e ToDo.Delete.

    

3.3. Atualizar a configuração do aplicativo

Use as seguintes etapas para atualizar o arquivo YAML para usar suas informações de aplicativo registrado do Microsoft Entra e estabelecer uma relação com o aplicativo de API RESTful:

1. Localize o arquivo src/main/resources/application.yml para o aplicativo simple-todo-api. Atualize a configuração na seção spring.cloud.azure.active-directory para corresponder ao exemplo a seguir. Substitua os espaços reservados pelos valores criados anteriormente.

   spring:
     cloud:
       azure:
         active-directory:
           profile:
             tenant-id: <tenant>
           credential:
             client-id: <your-application-ID-of-ToDo>
           app-id-uri: <your-application-ID-URI-of-ToDo>
   

   Observação

   Em tokens v1.0, a configuração requer a ID do cliente da API, enquanto em tokens v2.0, você pode usar a ID do cliente ou o URI da ID do aplicativo na solicitação. Você pode configurar ambos para concluir corretamente a validação do público-alvo.

   Os valores permitidos para tenant-id são: common, organizations, consumers ou a ID do locatário. Para obter mais informações sobre esses valores, consulte a seção Uso do ponto de extremidade incorreto (contas pessoais e de organização) do Error AADSTS50020 – A conta de usuário do provedor de identidade não existe no locatário. Para saber como converter seu aplicativo de locatário único, consulte Converter aplicativo de locatário único em multilocatário no Microsoft Entra ID.

2. Use o comando a seguir para recompilar o projeto de exemplo:

   ./mvnw clean package
   

4. Implantar o aplicativo em Aplicativos Spring do Azure

Agora você pode implantar o aplicativo em Aplicativos Spring do Azure.

Portal do Azure + plug-in do Maven

Use as etapas a seguir para implantar usando o plug-in Maven para Aplicativos Spring do Azure:

1. Navegue até o diretório completo e execute o seguinte comando para configurar o aplicativo em Aplicativos Spring do Azure:

   ./mvnw com.microsoft.azure:azure-spring-apps-maven-plugin:1.19.0:config
   

   A lista a seguir descreve as interações de comando:

   • Logon do OAuth2: autorize a entrada no Azure com base no protocolo OAuth2.
   • Selecionar assinatura: selecione o número da lista de assinaturas da instância dos Aplicativos Spring do Azure que você criou, que usa como padrão a primeira assinatura na lista. Se você usar o número padrão, pressione Enter diretamente.
   • Usar o Aplicativos Spring do Azure existente: pressione S para usar a instância existente do Aplicativos Spring do Azure.
   • Selecionar os Aplicativos Spring do Azure para implantação: selecione o número da instância dos Aplicativos Spring do Azure que você criou. Se você usar o número padrão, pressione Enter diretamente.
   • Use o aplicativo existente no Aplicativos Spring do Azure <nome da sua instância>: pressione S para usar o aplicativo criado.
   • Confirme para salvar todas as configurações acima: pressione S. Se você pressionar n, a configuração não será salva nos arquivos POM.

2. Use o seguinte comando para implantar o aplicativo:

   ./mvnw azure-spring-apps:deploy
   

   A lista a seguir descreve a interação de comando:

   • Logon do OAuth2: autorize a entrada no Azure com base no protocolo OAuth2.

   Depois que o comando for executado, você poderá pelas mensagens de log que a implantação foi bem-sucedida:

[INFO] Deployment(default) is successfully created
[INFO] Starting Spring App after deploying artifacts...
[INFO] Deployment Status: Running
[INFO]   InstanceName:demo--default-xxxxxxx-xxxxxxxxx-xxxxx  Status:Running Reason:null       DiscoverStatus:NONE
[INFO] Getting public url of app(demo)...
[INFO] Application url: https://demo.<unique-identifier>.<region-name>.azurecontainerapps.io

CLI do Desenvolvedor do Azure

Use as etapas a seguir para empacotar o aplicativo, provisionar os recursos do Azure exigidos pelo aplicativo Web e, em seguida, implantar em Aplicativos Spring do Azure.

1. Execute o seguinte comando para empacotar uma cópia implantável do aplicativo:

   azd package
   

2. Execute o seguinte comando para implantar o código do aplicativo nesses recursos recém-provisionados:

   azd deploy
   

   O console gera mensagens semelhantes ao exemplo a seguir:

   Deploying services (azd deploy)
   
   WARNING: Feature 'springapp' is in alpha stage.
   To learn more about alpha features and their support, visit https://aka.ms/azd-feature-stages.
   
   ...
   
   Deploying service simple-todo-api (Fetching endpoints for spring app service)
   - Endpoint: https://simple-todo-api.xxxxxxxx-xxxxxxxx.xxxxxx.azurecontainerapps.io
   
   
   SUCCESS: Your application was deployed to Azure in xx minutes xx seconds.
   You can view the resources created under the resource group rg-<your-environment-name> in Azure Portal:
   https://portal.azure.com/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/rg-<your-environment-name>/overview
   

   O ponto de extremidade de saída é o ponto de extremidade base para acessar o aplicativo de API ToDo.

Observação

O senhor também pode usar azd up para combinar os três comandos anteriores: azd provision (provisiona recursos do Azure), azd package (empacota uma cópia implantável do seu aplicativo) e azd deploy (implanta o código do aplicativo). Para obter mais informações, confira Azure-Samples/ASA-Samples-Restful-Application.

5. Validar os aplicativos

Agora, você pode acessar a API RESTful para conferir se ela funciona.

5.1. Solicitar um token de acesso

As APIs RESTful atuam como um servidor de recursos, que é protegido pelo Microsoft Entra ID. Antes de adquirir um token de acesso, você deverá registrar outro aplicativo no Microsoft Entra ID e conceder permissões ao aplicativo cliente, que é chamado ToDoWeb.

Registrar o aplicativo cliente

Use as seguintes etapas para registrar um aplicativo no Microsoft Entra ID, que é usado para adicionar as permissões para o aplicativo ToDo:

1. Entre no portal do Azure.

2. Se você tiver acesso a vários locatários, use o filtro Diretório + assinatura () para selecionar o locatário no qual quer registrar um aplicativo.

3. Pesquise e selecione Microsoft Entra ID.

4. Em Gerenciar, selecione Registros de aplicativo>Novo registro.

5. Insira um nome para seu aplicativo no campo Nome – por exemplo, ToDoWeb. Os usuários do seu aplicativo podem ver esse nome e você pode alterá-lo mais tarde.

6. Para tipos de conta com suporte, use o valor padrão Contas somente neste diretório organizacional.

7. Selecione Registrar para criar o aplicativo.

8. Na página Visão Geral do aplicativo, localize o valor da ID do aplicativo (cliente) e registre-o para uso posterior. Isso será necessário para adquirir um token de acesso.

9. Selecione Permissões de API>Adicionar uma permissão>Minhas APIs. Selecione o aplicativo ToDo que você registrou anteriormente e, em seguida, selecione as permissões ToDo.Read, ToDo.Writee ToDo.Delete. Selecione Adicionar permissões.

10. Selecione Conceder consentimento do administrador< para >your-tenant-name para conceder o consentimento do administrador para as permissões adicionadas.

    

Adicionar usuário para acessar as APIs RESTful

Use as etapas a seguir para criar um usuário membro em seu locatário do Microsoft Entra. Em seguida, o usuário pode gerenciar os dados do aplicativo por meio de APIs RESTful ToDo.

1. Em Gerenciar, selecione Usuários>Novo usuário>Criar novo usuário.

2. Na página Criar novo usuário, insira as seguintes informações:

   • Nome da entidade de usuário: insira um nome para o usuário.
   • Nome de exibição: insira um nome de exibição para o usuário.
   • Senha: copie a senha gerada automaticamente fornecida na caixa Senha.

   Observação

   Os novos usuários devem concluir a primeira autenticação de entrada e atualizar suas senhas, caso contrário, você receberá um erro AADSTS50055: The password is expired ao obter o token de acesso.

   Quando um novo usuário faz logon, ele recebe um prompt de Ação Necessária. Eles podem escolher Pedir mais tarde para ignorar a validação.

3. Selecione Revisar + criar para revisar suas seleções. Selecione Criar para criar o usuário.

Atualizar a configuração do OAuth2 para autorização da interface do usuário do Swagger

Use as etapas a seguir para atualizar a configuração do OAuth2 para autorização da interface do usuário do Swagger. Em seguida, você pode autorizar os usuários a adquirir tokens de acesso por meio do aplicativo ToDoWeb.

1. Abra o locatário do Microsoft Entra ID no portal do Azure e acesse o aplicativo registrado ToDoWeb.

2. Em Gerenciar, selecione Autenticação, Selecione Adicionar uma plataforma e selecione Aplicativo de página única.

3. Use o formato <your-app-exposed-application-URL-or-endpoint>/swagger-ui/oauth2-redirect.html como a URL de redirecionamento OAuth2 no campo Redirecionamento de URIs e selecione Configurar.

   

Obter o token de acesso

Use as etapas a seguir para usar o método de fluxo de código de autorização do OAuth 2.0 para obter um token de acesso com o Microsoft Entra ID e, em seguida, acessar as APIs RESTful do aplicativo ToDo:

1. Abra a URL exposta pelo aplicativo e selecione Autorizar para preparar a autenticação OAuth2.

2. Na janela Autorizações disponíveis, insira a ID do cliente do aplicativo ToDoWeb no campo client_id, selecione todos os escopos do campo Escopos, ignore o campo client_secret e selecione Autorizar para redirecionar para a página de entrada do Microsoft Entra.

Depois de concluir a entrada com o usuário anterior, você será retornado para a janela Autorizações disponíveis.

5.2. Acessar as APIs RESTful

Use as seguintes etapas para acessar as APIs RESTful do aplicativo ToDo na interface do usuário do Swagger:

1. Selecione a API POST /api/simple-todo/lists e, em seguida, selecione Experimentar. Insira o corpo da solicitação a seguir e selecione Executar para criar uma lista ToDo.

   {
     "name": "My List"
   }
   

   Depois que a execução for concluída, você verá o seguinte Corpo da resposta:

   {
     "id": "<ID-of-the-ToDo-list>",
     "name": "My List",
     "description": null
   }
   

2. Selecione a API POST /api/simple-todo/lists/{listId}/items e selecione Experimentar. Para listId, insira a ID da lista ToDo que você criou anteriormente, insira o corpo da solicitação a seguir e selecione Executar para criar um item ToDo.

   {
     "name": "My first ToDo item", 
     "listId": "<ID-of-the-ToDo-list>",
     "state": "todo"
   }
   

   Esta ação retorna o seguinte item ToDo:

   {
     "id": "<ID-of-the-ToDo-item>",
     "listId": "<ID-of-the-ToDo-list>",
     "name": "My first ToDo item",
     "description": null,
     "state": "todo",
     "dueDate": "2023-07-11T13:59:24.9033069+08:00",
     "completedDate": null
   }
   

3. Selecione a API GET /api/simple-todo/lists e, em seguida, selecione Executar para consultar listas de ToDo. Esta ação retorna as seguintes listas de ToDo:

   [
     {
       "id": "<ID-of-the-ToDo-list>",
       "name": "My List",
       "description": null
     }
   ]
   

4. Selecione a API GET /api/simple-todo/lists/{listId}/items e selecione Experimentar. Para listId, insira a ID da lista ToDo que você criou anteriormente e selecione Executar para consultar os itens ToDo. Esta ação retorna o seguinte item ToDo:

   [
     {
       "id": "<ID-of-the-ToDo-item>",
       "listId": "<ID-of-the-ToDo-list>",
       "name": "My first ToDo item",
       "description": null,
       "state": "todo",
       "dueDate": "2023-07-11T13:59:24.903307+08:00",
       "completedDate": null
     }
   ]
   

5. Selecione a API PUT /api/simple-todo/lists/{listId}/items/{itemId} e selecione Experimentar. Para listId, insira a ID da lista ToDo. Para itemId, insira a ID do item ToDo, insira o corpo da solicitação a seguir e selecione Executar para atualizar o item ToDo.

   {
     "id": "<ID-of-the-ToDo-item>",
     "listId": "<ID-of-the-ToDo-list>",
     "name": "My first ToDo item",
     "description": "Updated description.",
     "dueDate": "2023-07-11T13:59:24.903307+08:00",
     "state": "inprogress"
   }
   

   Esta ação retorna o seguinte item ToDo atualizado:

   {
     "id": "<ID-of-the-ToDo-item>",
     "listId": "<ID-of-the-ToDo-list>",
     "name": "My first ToDo item",
     "description": "Updated description.",
     "state": "inprogress",
     "dueDate": "2023-07-11T05:59:24.903307Z",
     "completedDate": null
   }
   

6. Selecione a API DELETE /api/simple-todo/lists/{listId}/items/{itemId} e selecione Experimentar. Para listId, insira a ID da lista ToDo. Para itemId, insira a ID do item ToDo e, em seguida, selecione Executar para excluir o item ToDo. Você deve ver que o código de resposta do servidor é 204.

6. Limpar os recursos

Você pode excluir o grupo de recursos do Azure, que inclui todos os recursos no grupo de recursos.

Portal do Azure + plug-in do Maven

Use as seguintes etapas para excluir todo o grupo de recursos, incluindo o serviço recém-criado:

1. Encontre o grupo de recursos no portal do Azure.

2. No menu de navegação, selecione Grupos de recursos. Em seguida, selecione o nome do grupo de recursos, por exemplo, myresourcegroup.

3. Na página do grupo de recursos, selecione Excluir. Insira o nome do grupo de recursos, como o exemplo myresourcegroup, na caixa de texto para confirmar a exclusão. Em seguida, selecione Excluir.

CLI do Azure

Use o comando a seguir para excluir todo o grupo de recursos, incluindo o serviço recém-criado:

az group delete --name ${RESOURCE_GROUP}

Portal do Azure + plug-in do Maven

Use as seguintes etapas para excluir todo o grupo de recursos, incluindo o serviço recém-criado:

1. Encontre o grupo de recursos no portal do Azure.

2. No menu de navegação, selecione Grupos de recursos. Em seguida, selecione o nome do grupo de recursos, por exemplo, myresourcegroup.

3. Na página do grupo de recursos, selecione Excluir. Insira o nome do grupo de recursos, como o exemplo myresourcegroup, na caixa de texto para confirmar a exclusão. Em seguida, selecione Excluir.

CLI do Desenvolvedor do Azure

Use o seguinte comando para excluir todos os recursos do Azure usados neste aplicativo de exemplo:

azd down

A lista a seguir descreve a interação de comando:

• Total de recursos a serem excluídos: [your-resources-total], tem certeza de que deseja continuar?: pressione s.

O console gera mensagens semelhantes ao exemplo a seguir:

SUCCESS: Your application was removed from Azure in xx minutes xx seconds.

7. Próximas etapas

Início Rápido: Implantar um aplicativo controlado por evento nos Aplicativos Spring do Azure

Início Rápido: Como implantar aplicativos de microsserviço nos Aplicativos Spring do Azure

Log do aplicativo estruturado para o Azure Spring Apps

Mapear um domínio personalizado existente para os Aplicativos Spring do Azure

Usa a CI/CD do Azure Spring Apps com o GitHub Actions

Automatizar implantações de aplicativos no Azure Spring Apps

Para obter mais informações, consulte os seguintes artigos:

• Exemplos de Aplicativos Spring do Azure .
• Spring no Azure
• Azure Spring Cloud