Snabbstart: Distribuera RESTful API-program till Azure Spring Apps

Kommentar

Basic-, Standard- och Enterprise-planerna kommer att vara inaktuella från och med mitten av mars 2025, med en 3-årig pensionsperiod. Vi rekommenderar att du övergår till Azure Container Apps. Mer information finns i meddelandet om azure Spring Apps-pensionering.

Standardförbrukningen och den dedikerade planen kommer att vara inaktuell från och med den 30 september 2024, med en fullständig avstängning efter sex månader. Vi rekommenderar att du övergår till Azure Container Apps. Mer information finns i Migrera Azure Spring Apps Standard-förbrukning och dedikerad plan till Azure Container Apps.

I den här artikeln beskrivs hur du distribuerar ett RESTful API-program som skyddas av Microsoft Entra-ID till Azure Spring Apps. Exempelprojektet är en förenklad version baserad på simple todo-webbappen , som endast tillhandahåller serverdelstjänsten och använder Microsoft Entra-ID för att skydda RESTful-API:erna.

Dessa RESTful-API:er skyddas genom att tillämpa rollbaserad åtkomstkontroll (RBAC). Anonyma användare kan inte komma åt några data och får inte styra åtkomsten för olika användare. Anonyma användare har bara följande tre behörigheter:

• Läs: Med den här behörigheten kan en användare läsa ToDo-data.
• Skriv: Med den här behörigheten kan en användare lägga till eller uppdatera ToDo-data.
• Ta bort: Med den här behörigheten kan en användare ta bort ToDo-data.

När distributionen har slutförts kan du visa och testa API:erna via Swagger-användargränssnittet.

Följande diagram visar systemets arkitektur:

I den här artikeln beskrivs följande alternativ för att skapa resurser och distribuera dem till Azure Spring Apps:

• Plugin-alternativet Azure Portal + Maven är ett mer konventionellt sätt att skapa resurser och distribuera program steg för steg. Det här alternativet är lämpligt för Spring-utvecklare som använder Azure-molntjänster för första gången.
• Cli-alternativet Azure Developer är ett effektivare sätt att automatiskt skapa resurser och distribuera program via enkla kommandon. Azure Developer CLI använder en mall för att etablera de Azure-resurser som behövs och för att distribuera programkoden. Det här alternativet är lämpligt för Spring-utvecklare som är bekanta med Azure-molntjänster.

I den här artikeln beskrivs följande alternativ för att skapa resurser och distribuera dem till Azure Spring Apps:

• Plugin-alternativet Azure Portal + Maven är ett mer konventionellt sätt att skapa resurser och distribuera program steg för steg. Det här alternativet är lämpligt för Spring-utvecklare som använder Azure-molntjänster för första gången.
• Azure CLI-alternativet använder ett kraftfullt kommandoradsverktyg för att hantera Azure-resurser. Det här alternativet är lämpligt för Spring-utvecklare som är bekanta med Azure-molntjänster.

1. Förutsättningar

Azure Portal + Maven-plugin-program

• En Azure-prenumeration Om du inte har en Azure-prenumeration skapar du ett kostnadsfritt Azure-konto innan du börjar.

• En av följande roller:

  • Global administratör eller privilegierad rolladministratör för att bevilja medgivande för appar som begär en behörighet för valfritt API.
  • Molnprogramadministratör eller programadministratör för att bevilja medgivande för appar som begär behörighet för alla API:er, förutom Microsoft Graph-approller (programbehörigheter).
  • En anpassad katalogroll som innehåller behörighet att bevilja behörigheter till program för de behörigheter som krävs av programmet.

  Mer information finns i Bevilja administratörsmedgivande för hela klientorganisationen till ett program.

• Om du distribuerar en Azure Spring Apps Enterprise-planinstans för första gången i målprenumerationen läser du avsnittet Krav i Enterprise-plan på Azure Marketplace.

• Git.

• Java Development Kit (JDK), version 17.

• En Microsoft Entra-klientorganisation. Anvisningar om hur du skapar en finns i Snabbstart: Skapa en ny klientorganisation i Microsoft Entra-ID.

Azure CLI

• Om du inte har en Azure-prenumeration skapar du ett kostnadsfritt Azure-konto innan du börjar.

• En av följande roller:

  • Global administratör eller privilegierad rolladministratör för att bevilja medgivande för appar som begär en behörighet för valfritt API.
  • Molnprogramadministratör eller programadministratör för att bevilja medgivande för appar som begär behörighet för alla API:er, förutom Microsoft Graph-approller (programbehörigheter).
  • En anpassad katalogroll som innehåller behörighet att bevilja behörigheter till program för de behörigheter som krävs av programmet.

  Mer information finns i Bevilja administratörsmedgivande för hela klientorganisationen till ett program.

• Om du distribuerar en Azure Spring Apps Enterprise-planinstans för första gången i målprenumerationen läser du avsnittet Krav i Enterprise-plan på Azure Marketplace.

• Git.

• Java Development Kit (JDK), version 17.

• En Microsoft Entra-klientorganisation. Anvisningar om hur du skapar en finns i Snabbstart: Skapa en ny klientorganisation i Microsoft Entra-ID.

• Azure CLI version 2.53.1 eller senare.

Azure Portal + Maven-plugin-program

• Om du inte har en Azure-prenumeration skapar du ett kostnadsfritt Azure-konto innan du börjar.

• En av följande roller:

  • Global administratör eller privilegierad rolladministratör för att bevilja medgivande för appar som begär en behörighet för valfritt API.
  • Molnprogramadministratör eller programadministratör för att bevilja medgivande för appar som begär behörighet för alla API:er, förutom Microsoft Graph-approller (programbehörigheter).
  • En anpassad katalogroll som innehåller behörighet att bevilja behörigheter till program för de behörigheter som krävs av programmet.

  Mer information finns i Bevilja administratörsmedgivande för hela klientorganisationen till ett program.

• Git.

• Java Development Kit (JDK), version 17.

• En Microsoft Entra-klientorganisation. Anvisningar om hur du skapar en finns i Snabbstart: Skapa en ny klientorganisation i Microsoft Entra-ID.

Azure Developer CLI

• Om du inte har en Azure-prenumeration skapar du ett kostnadsfritt Azure-konto innan du börjar.

• En av följande roller:

  • Global administratör eller privilegierad rolladministratör för att bevilja medgivande för appar som begär en behörighet för valfritt API.
  • Molnprogramadministratör eller programadministratör för att bevilja medgivande för appar som begär behörighet för alla API:er, förutom Microsoft Graph-approller (programbehörigheter).
  • En anpassad katalogroll som innehåller behörighet att bevilja behörigheter till program för de behörigheter som krävs av programmet.

  Mer information finns i bevilja administratörsmedgivande.

• Git.

• Java Development Kit (JDK), version 17.

• En Microsoft Entra-klientorganisation. Anvisningar om hur du skapar en finns i Snabbstart: Skapa en ny klientorganisation i Microsoft Entra-ID.

• Azure Developer CLI (AZD), version 1.0.2 eller senare.

2. Förbereda Spring-projektet

För att distribuera RESTful API-appen är det första steget att förbereda Spring-projektet för att köras lokalt.

Använd följande steg för att klona och köra appen lokalt:

1. Använd följande kommando för att klona exempelprojektet från GitHub:

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

2. Om du vill köra appen lokalt slutför du stegen i avsnittet Exponera RESTful-API:er och Uppdatera programkonfigurationsavsnitten först och använder sedan följande kommando för att köra exempelprogrammet med Maven:

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

3. Förbereda molnmiljön

De viktigaste resurserna som krävs för att köra den här exempelappen är en Azure Spring Apps-instans och en Azure Database for PostgreSQL-instans. I följande avsnitt beskrivs hur du skapar dessa resurser.

Azure Portal + Maven-plugin-program

3.1. Logga in på Azure-portalen

Gå till Azure Portal och ange dina autentiseringsuppgifter för att logga in på portalen. Standardvyn är instrumentpanelen.

3.2. Skapa en Azure Spring Apps-instans

Använd följande steg för att skapa en Azure Spring Apps-tjänstinstans:

1. Välj Skapa en resurs i hörnet av Azure Portal.

2. Välj Beräkna>Azure Spring Apps.

3. Fyll i formuläret Grundläggande med följande information:

   Inställning	Föreslaget värde	beskrivning
   Abonnemang	Namnet på din prenumeration.	Den Azure-prenumeration som ska användas för servern. Om du har flera prenumerationer väljer du den prenumeration där du vill debiteras för resursen.
   Resursgrupp	myresourcegroup	Ett nytt resursgruppnamn eller ett befintligt namn i prenumerationen.
   Namn	myasa	Ett unikt namn som identifierar din Azure Spring Apps-tjänst. Namnet måste vara mellan 4 och 32 tecken långt och får endast innehålla gemener, siffror och bindestreck. Det första tecknet i tjänstnamnet måste vara en bokstav och det sista tecknet måste vara antingen en bokstav eller ett tal.
   Planera	Enterprise	Prisplanen som avgör vilken resurs och kostnad som är associerad med din instans.
   Region	Den region som är närmast dina användare.	Den plats som är närmast dina användare.
   Zonredundant	Inte markerat	Alternativet att skapa din Azure Spring Apps-tjänst i en Azure-tillgänglighetszon. Den här funktionen stöds för närvarande inte i alla regioner.
   Ip-plan för programvara	Betala per användning	Prisplanen som låter dig betala per användning med Azure Spring Apps.
   Villkor	Har valts	Kryssrutan avtal som är associerad med Marketplace-erbjudandet. Du måste markera den här kryssrutan.
   Distribuera exempelprojekt	Inte markerat	Alternativet att använda det inbyggda exempelprogrammet.

4. Välj Granska och skapa för att granska dina val. Välj sedan Skapa för att etablera Azure Spring Apps-instansen.

5. Välj ikonen Aviseringar (en bjällra) i verktygsfältet för att övervaka distributionsprocessen. När distributionen är klar kan du välja Fäst på instrumentpanelen, vilket skapar en panel för den här tjänsten på din Azure Portal instrumentpanel som en genväg till tjänstens översiktssida.

   

6. Välj Gå till resurs för att gå till översiktssidan för Azure Spring Apps .

3.3. Förbereda PostgreSQL-instansen

Använd följande steg för att skapa en Azure Database for PostgreSQL-server:

1. Gå till Azure Portal och välj Skapa en resurs.

2. Välj Databaser>Azure-databas för PostgreSQL.

3. Välj alternativet Flexibel serverdistribution.

   

4. Fyll i fliken Grundläggande med följande information:

   • Servernamn: my-demo-pgsql
   • Region: USA, östra
   • PostgreSQL-version: 14
   • Arbetsbelastningstyp: Utveckling
   • Aktivera hög tillgänglighet: avmarkerad
   • Autentiseringsmetod: Endast PostgreSQL-autentisering
   • Administratörsanvändarnamn: myadmin
   • Lösenord och bekräfta lösenord: Ange ett lösenord.

5. Använd följande information för att konfigurera fliken Nätverk :

   • Anslutningsmetod: Offentlig åtkomst (tillåtna IP-adresser)
   • Tillåt offentlig åtkomst från valfri Azure-tjänst i Azure till den här servern: vald

6. Välj Granska + skapa för att granska dina val och välj Skapa för att etablera servern. Den här åtgärden kan ta några minuter.

7. Gå till din PostgreSQL-server i Azure-portalen. På sidan Översikt letar du efter värdet Servernamn och registrerar det för senare användning. Du behöver den för att konfigurera miljövariablerna för appen i Azure Spring Apps.

8. Välj Databaser på navigeringsmenyn för att skapa en databas , till exempel att göra.

   

3.4. Ansluta appinstansen till PostgreSQL-instansen

Använd följande steg för att ansluta dina tjänstinstanser:

1. Gå till din Azure Spring Apps-instans i Azure Portal.

2. Öppna Appar på navigeringsmenyn och välj sedan Skapa app.

3. På sidan Skapa app fyller du i appnamnet simple-todo-api och väljer sedan Java-artefakter som distributionstyp .

4. Välj Skapa för att slutföra skapandet av appen och välj sedan appen för att visa informationen.

5. Gå till appen som du skapade i Azure Portal. På sidan Översikt väljer du Tilldela slutpunkt för att exponera appens offentliga slutpunkt. Spara URL:en för åtkomst till appen efter distributionen.

6. Välj Tjänstanslutning i navigeringsfönstret och välj sedan Skapa för att skapa en ny tjänstanslutning.

   

7. Fyll i fliken Grundläggande med följande information:

   • Tjänsttyp: DB för Flexibel PostgreSQL-server
   • Anslutningsnamn: Ett automatiskt genererat namn fylls i, vilket också kan ändras.
   • Prenumeration: Välj din prenumeration.
   • PostgreSQL – flexibel server: my-demo-pgsql
   • PostgreSQL-databas: Välj den databas som du skapade.
   • Klienttyp: SpringBoot

   

8. Konfigurera fliken Nästa: Autentisering med följande information:

   • Välj den autentiseringstyp som du vill använda mellan beräkningstjänsten och måltjänsten.: Välj Anslutningssträng.
   • Fortsätt med...: Välj databasautentiseringsuppgifter
   • Användarnamn: myadmin
   • Lösenord: Ange ditt lösenord.

   

9. Välj Nästa: Nätverk. Använd standardalternativet Konfigurera brandväggsregler för att aktivera åtkomst till måltjänsten.

10. Välj Nästa: Granska och skapa för att granska dina val och välj sedan Skapa för att skapa anslutningen.

3.5. Exponera RESTful-API:er

Använd följande steg för att exponera dina RESTful-API:er i Microsoft Entra-ID:

1. Logga in på Azure-portalen.

2. Om du har åtkomst till flera klienter använder du filtret Katalog + prenumeration ( ) för att välja den klientorganisation där du vill registrera ett program.

3. Sök efter och markera Microsoft Entra ID.

4. Under Hantera väljer du Appregistreringar> Ny registrering.

5. Ange ett namn för ditt program i fältet Namn , till exempel Todo. Användare av din app kan se det här namnet och du kan ändra det senare.

6. För Kontotyper som stöds väljer du Konton i valfri organisationskatalog (Alla Microsoft Entra-kataloger – Flera klientorganisationer) och personliga Microsoft-konton.

7. Välj Registrera för att skapa programmet.

8. På appöversiktssidan letar du efter värdet program-ID (klient) och registrerar det för senare användning. Du behöver den för att konfigurera YAML-konfigurationsfilen för det här projektet.

9. Under Hantera väljer du Exponera ett API, letar upp program-ID-URI:n i början av sidan och väljer sedan Lägg till.

10. På sidan Redigera program-ID-URI accepterar du den föreslagna program-ID-URI:n (api://{client ID}) eller använder ett beskrivande namn i stället för klient-ID:t, till exempel api://simple-todo, och väljer sedan Spara.

11. Under Hantera väljer du Exponera ett API>Lägg till ett omfång och anger sedan följande information:

    • Som Omfångsnamn anger du ToDo.Read.
    • För Vem kan samtycka väljer du endast Administratörer.
    • För Visningsnamn för administratörsmedgivande anger du Läs ToDo-data.
    • Som Beskrivning av administratörsmedgivande anger du Tillåt autentiserade användare att läsa ToDo-data..
    • För Tillstånd behåller du det aktiverat.
    • Välj Lägg till definitionsområde.

12. Upprepa föregående steg för att lägga till de andra två omfången: ToDo.Write och ToDo.Delete.

    

3.6. Uppdatera programkonfigurationen

Använd följande steg för att uppdatera YAML-filen för att använda din Microsoft Entra-registrerade programinformation för att upprätta en relation med RESTful API-programmet:

1. Leta upp filen src/main/resources/application.yml för simple-todo-api appen. Uppdatera konfigurationen spring.cloud.azure.active-directory i avsnittet så att den matchar följande exempel. Se till att ersätta platshållarna med de värden som du skapade tidigare.

   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>
   

   Kommentar

   I v1.0-token kräver konfigurationen klient-ID för API:et, medan du i v2.0-token kan använda klient-ID:t eller program-ID:ts URI i begäran. Du kan konfigurera båda för att slutföra målgruppsverifieringen korrekt.

   De värden som tillåts för tenant-id är: common, organizations, consumerseller klientorganisations-ID. Mer information om dessa värden finns i avsnittet Använd fel slutpunkt (personliga konton och organisationskonton) i Fel AADSTS50020 – Användarkonto från identitetsprovidern finns inte i klientorganisationen. Information om hur du konverterar din app för en klientorganisation finns i Konvertera en klientorganisationsapp till flera klientorganisationer på Microsoft Entra-ID.

2. Använd följande kommando för att återskapa exempelprojektet:

   ./mvnw clean package
   

Azure CLI

3.1. Ange namn för varje resurs

Skapa variabler för att lagra resursnamnen med hjälp av följande kommandon. Se till att ersätta platshållarna med dina egna värden.

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. Skapa en ny resursgrupp

Använd följande steg för att skapa en ny resursgrupp:

1. Använd följande kommando för att logga in på Azure CLI:

   az login
   

2. Använd följande kommando för att ange standardplatsen:

   az configure --defaults location=${LOCATION}
   

3. Använd följande kommando för att lista alla tillgängliga prenumerationer för att fastställa vilket prenumerations-ID som ska användas:

   az account list --output table
   

4. Använd följande kommando för att ange standardprenumerationen:

   az account set --subscription <subscription-ID>
   

5. Använd följande kommando för att skapa en resursgrupp:

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

6. Använd följande kommando för att ange den nyligen skapade resursgruppen som standardresursgrupp:

   az configure --defaults group=${RESOURCE_GROUP}
   

3.3. Installera tillägget och registrera namnområdet

Använd följande kommandon för att installera Azure Spring Apps-tillägget för Azure CLI och registrera Microsoft.SaaS namnområdet:

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

3.4. Skapa en Azure Spring Apps-instans

Använd följande steg för att skapa en tjänstinstans och ett program i instansen:

1. Använd följande kommando för att godkänna de juridiska villkoren och sekretesspolicyerna för Enterprise-planen:

   Kommentar

   Det här steget är bara nödvändigt om din prenumeration aldrig har använts för att skapa en Enterprise-planinstans av Azure Spring Apps.

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

2. Använd följande kommando för att skapa en Azure Spring Apps-tjänstinstans:

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

3. Använd följande kommando för att skapa ett program i Azure Spring Apps-instansen:

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

3.5. Förbereda PostgreSQL-instansen

Spring-webbappen använder H2 för databasen i localhost och Azure Database for PostgreSQL för databasen i Azure.

Använd följande kommando för att skapa en PostgreSQL-instans:

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

Om du anger 0.0.0.0 aktiveras offentlig åtkomst från alla resurser som distribueras i Azure för att få åtkomst till servern.

3.6. Ansluta appinstansen till PostgreSQL-instansen

När programinstansen och PostgreSQL-instansen har skapats kan programinstansen inte komma åt PostgreSQL-instansen direkt. Använd följande steg för att göra det möjligt för appen att ansluta till PostgreSQL-instansen:

1. Använd följande kommando för att hämta PostgreSQL-instansens fullständigt kvalificerade domännamn:

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

2. Använd följande kommando för att ange spring.datasource. egenskaperna för appen via miljövariabler:

   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. Exponera RESTful-API:er

Använd följande steg för att exponera RESTful-API:erna:

1. Använd följande kommando för att skapa ett Microsoft Entra-ID-program:

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

2. Använd följande kommando för att skapa ett huvudnamn för tjänsten för programmet:

   az ad sp create --id ${TODO_APP_URL}
   

3. Använd följande kommando för att generera behörighets-ID:t:

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

4. Lägg till följande omfång som 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. Använd följande kommando för att lägga till omfång:

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

6. Använd följande kommando för att hämta klient-ID:t som ska användas i nästa steg:

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

7. Använd följande kommando för att hämta program-ID:t som ska användas i nästa steg:

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

3.8. Uppdatera programkonfigurationen

Använd följande steg för att uppdatera YAML-filen för att använda din Microsoft Entra-registrerade programinformation för att upprätta en relation med RESTful API-programmet:

1. Leta upp filen src/main/resources/application.yml för simple-todo-api appen. Uppdatera konfigurationen spring.cloud.azure.active-directory i avsnittet så att den matchar följande exempel. Se till att ersätta platshållarna med de värden som du skapade tidigare.

   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>
   

   Kommentar

   I v1.0-token kräver konfigurationen klient-ID för API:et, medan du i v2.0-token kan använda klient-ID:t eller program-ID:ts URI i begäran. Du kan konfigurera båda för att slutföra målgruppsverifieringen korrekt.

   De värden som tillåts för tenant-id är: common, organizations, consumerseller klientorganisations-ID. Mer information om dessa värden finns i avsnittet Använd fel slutpunkt (personliga konton och organisationskonton) i Fel AADSTS50020 – Användarkonto från identitetsprovidern finns inte i klientorganisationen. Information om hur du konverterar din app för en klientorganisation finns i Konvertera en klientorganisationsapp till flera klientorganisationer på Microsoft Entra-ID.

2. Använd följande kommando för att återskapa exempelprojektet:

   ./mvnw clean package
   

4. Distribuera appen till Azure Spring Apps

Azure Portal + Maven-plugin-program

Nu kan du distribuera appen till Azure Spring Apps.

Använd följande steg för att distribuera med maven-plugin-programmet för Azure Spring Apps:

1. Gå till den fullständiga katalogen och kör sedan följande kommando för att konfigurera appen i Azure Spring Apps:

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

   I följande lista beskrivs kommandointeraktionerna:

   • OAuth2-inloggning: Du måste auktorisera inloggningen till Azure baserat på OAuth2-protokollet.
   • Välj prenumeration: Välj prenumerationslistans nummer för den Azure Spring Apps-instans som du skapade, som standard är den första prenumerationen i listan. Om du använder standardnumret trycker du på Retur direkt.
   • Använd befintliga Azure Spring Apps i Azure: Tryck på y för att använda den befintliga Azure Spring Apps-instansen.
   • Välj Azure Spring Apps för distribution: Välj antalet Azure Spring Apps-instanser som du skapade. Om du använder standardnumret trycker du på Retur direkt.
   • Använd befintlig app i Azure Spring Apps <ditt-instansnamn>: Tryck på y för att använda den skapade appen.
   • Bekräfta för att spara alla ovanstående konfigurationer: Tryck på y. Om du trycker på n sparas inte konfigurationen i POM-filerna.

2. Använd följande kommando för att distribuera appen:

   ./mvnw azure-spring-apps:deploy
   

   I följande lista beskrivs kommandointeraktionen:

   • OAuth2-inloggning: Du måste auktorisera inloggningen till Azure baserat på OAuth2-protokollet.

   När kommandot har körts kan du se från följande loggmeddelanden att distributionen lyckades:

[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

Azure CLI

Använd följande kommando för att distribuera appen baserat på källkod:

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

5. Verifiera appen

Azure Portal + Maven-plugin-program

Nu kan du komma åt RESTful-API:et för att se om det fungerar.

5.1. Begära en åtkomsttoken

RESTful-API:erna fungerar som en resursserver, som skyddas av Microsoft Entra-ID. Innan du hämtar en åtkomsttoken måste du registrera ett annat program i Microsoft Entra-ID och bevilja behörigheter till klientprogrammet, som heter ToDoWeb.

Registrera klientprogrammet

Använd följande steg för att registrera ett program i Microsoft Entra-ID, som används för att lägga till behörigheter för ToDo appen:

1. Logga in på Azure-portalen.

2. Om du har åtkomst till flera klienter använder du filtret Katalog + prenumeration ( ) för att välja den klientorganisation där du vill registrera ett program.

3. Sök efter och markera Microsoft Entra ID.

4. Under Hantera väljer du Appregistreringar> Ny registrering.

5. Ange ett namn för ditt program i fältet Namn , till exempel ToDoWeb. Användare av din app kan se det här namnet och du kan ändra det senare.

6. För kontotyper som stöds använder du endast standardvärdet Konton i den här organisationskatalogen.

7. Välj Registrera för att skapa programmet.

8. På appöversiktssidan letar du efter värdet program-ID (klient) och registrerar det för senare användning. Du behöver den för att hämta en åtkomsttoken.

9. Välj API-behörigheter>Lägg till en behörighet>Mina API:er. Välj det ToDo program som du registrerade tidigare och välj sedan behörigheterna ToDo.Read, ToDo.Write och ToDo.Delete . Välj Lägg till behörigheter.

10. Välj Bevilja administratörsmedgivande för ditt klientnamn> för <att bevilja administratörsmedgivande för de behörigheter som du har lagt till.

    

Lägg till användare för att komma åt RESTful-API:er

Använd följande steg för att skapa en medlemsanvändare i din Microsoft Entra-klientorganisation. Sedan kan användaren hantera programmets ToDo data via RESTful-API:er.

1. Under Hantera väljer du Användare>Ny användare>Skapa ny användare.

2. På sidan Skapa ny användare anger du följande information:

   • Användarens huvudnamn: Ange ett namn för användaren.
   • Visningsnamn: Ange ett visningsnamn för användaren.
   • Lösenord: Kopiera det automatiskt genererade lösenordet som anges i rutan Lösenord .

   Kommentar

   Nya användare måste slutföra den första inloggningsautentiseringen och uppdatera sina lösenord, annars får du ett AADSTS50055: The password is expired fel när du får åtkomsttoken.

   När en ny användare loggar in får de en uppmaning om åtgärd som krävs . De kan välja Fråga senare för att hoppa över valideringen.

3. Välj Granska + skapa för att granska dina val. Välj Skapa för att skapa användaren.

Uppdatera OAuth2-konfigurationen för Swagger UI-auktorisering

Använd följande steg för att uppdatera OAuth2-konfigurationen för Swagger UI-auktorisering. Sedan kan du auktorisera användare att hämta åtkomsttoken via ToDoWeb appen.

1. Öppna din Microsoft Entra ID-klientorganisation i Azure Portal och gå till den registrerade ToDoWeb appen.

2. Under Hantera väljer du Autentisering, lägger till en plattform och väljer sedan Ensidesprogram.

3. Använd formatet <your-app-exposed-application-URL-or-endpoint>/swagger-ui/oauth2-redirect.html som omdirigerings-URL för OAuth2 i fältet Omdirigerings-URI:er och välj sedan Konfigurera.

   

Azure CLI

Nu kan du komma åt RESTful-API:et för att se om det fungerar.

5.1. Begära en åtkomsttoken

RESTful-API:erna fungerar som en resursserver, som skyddas av Microsoft Entra-ID. Innan du hämtar en åtkomsttoken måste du registrera ett annat program i Microsoft Entra-ID och bevilja behörigheter till klientprogrammet, som heter ToDoWeb.

Registrera klientprogrammet

Använd följande steg för att registrera klientprogrammet:

1. Använd följande kommando för att skapa ett Microsoft Entra-ID-program som används för att lägga till behörigheterna för ToDo appen:

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

2. Använd följande kommando för att lägga till behörigheter:

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

3. Använd följande kommando för att bevilja administratörsmedgivande för de behörigheter som du har lagt till:

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

4. Använd följande kommando för att hämta klient-ID för appen ToDoWeb som används i steget Hämta åtkomsttoken :

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

Lägg till användare för att komma åt RESTful-API:er

Använd följande kommando för att skapa en medlemsanvändare i din Microsoft Entra-klientorganisation. Sedan kan användaren hantera programmets ToDo data via RESTful-API:er:

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

Uppdatera OAuth2-konfigurationen för Swagger UI-auktorisering

Använd följande steg för att uppdatera OAuth2-konfigurationen:

1. Använd följande kommando för att hämta appens ToDoWeb objekt-ID:

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

2. Använd följande kommando för att hämta url:en för din simple-todo-api app:

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

3. Använd följande kommando för att uppdatera OAuth2-konfigurationen för Swagger UI-auktorisering och ersätta <object-id> platshållarna och <URL> med de parametervärden du fick. Sedan kan du auktorisera användare att hämta åtkomsttoken via ToDoWeb appen.

   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. Förbereda Spring-projektet

För att distribuera RESTful API-appen är det första steget att förbereda Spring-projektet för att köras lokalt.

Azure Portal + Maven-plugin-program

Använd följande steg för att klona och köra appen lokalt:

1. Använd följande kommando för att klona exempelprojektet från GitHub:

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

2. Om du vill köra appen lokalt slutför du stegen i avsnittet Exponera RESTful-API:er och Uppdatera programkonfigurationsavsnitten först och använder sedan följande kommando för att köra exempelprogrammet med Maven:

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

Azure Developer CLI

Använd följande steg för att initiera webbprogrammet från Azure Developer CLI-mallar:

1. Öppna en terminal, skapa en ny tom mapp och ändra sedan katalogen till den.

2. Kör följande kommando för att initiera projektet:

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

   I följande lista beskrivs kommandointeraktionerna:

   • OAuth2-inloggning: Du måste auktorisera inloggningen till Azure baserat på OAuth2-protokollet.
   • Ange ett nytt miljönamn: Ange ett miljönamn. Det här namnet används som ett suffix för resursgruppen som skapats för att lagra alla Azure-resurser. Det här namnet ska vara unikt i din Azure-prenumeration.

   Konsolen matar ut meddelanden som liknar följande exempel:

   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. Förbereda molnmiljön

De viktigaste resurserna som krävs för att köra den här exempelappen är en Azure Spring Apps-instans och en Azure Database for PostgreSQL-instans. I följande avsnitt beskrivs hur du skapar dessa resurser.

Azure Portal + Maven-plugin-program

3.1. Logga in på Azure-portalen

Gå till Azure Portal och ange dina autentiseringsuppgifter för att logga in på portalen. Standardvyn är instrumentpanelen.

3.2. Skapa en Azure Spring Apps-instans

Använd följande steg för att skapa en tjänstinstans:

1. Välj Skapa en resurs i hörnet av portalen.

2. Välj Beräkna>Azure Spring Apps.

3. Fyll i formuläret Grundläggande . Använd följande tabell som en guide för att fylla i formuläret. Det rekommenderade planvärdet är Standardförbrukning och dedikerad (förhandsversion).

   Inställning	Föreslaget värde	beskrivning
   Abonnemang	Namnet på din prenumeration.	Den Azure-prenumeration som ska användas för servern. Om du har flera prenumerationer väljer du den prenumeration där du vill debiteras för resursen.
   Resursgrupp	myresourcegroup	Ett nytt resursgruppnamn eller ett befintligt namn i prenumerationen.
   Namn	myasa	Ett unikt namn som identifierar din Azure Spring Apps-tjänst. Namnet måste vara mellan 4 och 32 tecken långt och får endast innehålla gemener, siffror och bindestreck. Det första tecknet i tjänstnamnet måste vara en bokstav och det sista tecknet måste vara antingen en bokstav eller ett tal.
   Planera	Standardförbrukning och dedikerad (förhandsversion)	Prisplanen avgör vilka resurser och kostnader som är kopplade till din instans.
   Region	Den region som är närmast dina användare.	Den plats som är närmast dina användare.
   Container Apps-miljö	myenvironment	Alternativet att välja vilken Container Apps-miljöinstans som ska dela samma virtuella nätverk med andra tjänster och resurser.

   Använd följande tabell som en guide för att skapa Container Apps Environment:

   Inställning	Föreslaget värde	beskrivning
   Miljönamn	myenvironment	Ett unikt namn som identifierar din Azure Container Apps Environment-tjänst.
   Planera	Förbrukning	Prisplanen avgör vilka resurser och kostnader som är kopplade till din instans.
   Zonredundant	Inaktiverad	Alternativet för att skapa din Container Apps Environment-tjänst i en Azure-tillgänglighetszon.

4. Välj Granska och skapa för att granska dina val. Välj sedan Skapa för att etablera Azure Spring Apps-instansen.

5. Välj ikonen Aviseringar (en bjällra) i verktygsfältet för att övervaka distributionsprocessen. När distributionen är klar kan du välja Fäst på instrumentpanelen, vilket skapar en panel för den här tjänsten på din Azure Portal instrumentpanel som en genväg till tjänstens översiktssida.

6. Välj Gå till resurs för att öppna tjänstens översiktssida.

   

Viktigt!

Förbrukningsarbetsbelastningsprofilen har en faktureringsmodell för användningsbaserad betalning utan startkostnad. Du debiteras för den dedikerade arbetsbelastningsprofilen baserat på de etablerade resurserna. Mer information finns i Arbetsbelastningsprofiler i Priser för Azure Container Apps och Azure Spring Apps.

3.3. Förbereda PostgreSQL-instansen

Använd följande steg för att skapa en Azure Database for PostgreSQL-server:

1. Gå till Azure Portal och välj Skapa en resurs.

2. Välj Databaser>Azure-databas för PostgreSQL.

3. Välj alternativet Flexibel serverdistribution.

   

4. Fyll i fliken Grundläggande med följande information:

   • Servernamn: my-demo-pgsql
   • Region: USA, östra
   • PostgreSQL-version: 14
   • Arbetsbelastningstyp: Utveckling
   • Aktivera hög tillgänglighet: avmarkerad
   • Autentiseringsmetod: Endast PostgreSQL-autentisering
   • Administratörsanvändarnamn: myadmin
   • Lösenord och bekräfta lösenord: Ange ett lösenord.

5. Använd följande information för att konfigurera fliken Nätverk :

   • Anslutningsmetod: Offentlig åtkomst (tillåtna IP-adresser)
   • Tillåt offentlig åtkomst från valfri Azure-tjänst i Azure till den här servern: vald

6. Välj Granska + skapa för att granska dina val och välj Skapa för att etablera servern. Den här åtgärden kan ta några minuter.

7. Gå till din PostgreSQL-server i Azure-portalen. På sidan Översikt letar du efter värdet Servernamn och registrerar det för senare användning. Du behöver den för att konfigurera miljövariablerna för appen i Azure Spring Apps.

8. Välj Databaser på navigeringsmenyn för att skapa en databas , till exempel att göra.

   

3.4. Ansluta appinstansen till PostgreSQL-instansen

Använd följande steg för att ansluta dina tjänstinstanser:

1. Gå till din Azure Spring Apps-instans i Azure Portal.

2. Öppna Appar på navigeringsmenyn och välj sedan Skapa app.

3. På sidan Skapa app fyller du i appnamnet simple-todo-api och väljer Java-artefakter som distributionstyp .

4. Välj Skapa för att slutföra skapandet av appen och välj appen för att visa informationen.

5. Gå till appen som du skapade i Azure Portal. På sidan Översikt väljer du Tilldela slutpunkt för att exponera appens offentliga slutpunkt. Spara URL:en för åtkomst till appen efter distributionen.

6. Gå till appen du skapade, expandera Inställningar och välj Konfiguration på navigeringsmenyn och välj sedan Miljövariabler för att ange miljövariablerna.

7. Lägg till följande miljövariabler för PostgreSQL-anslutningen och välj sedan Spara för att slutföra appkonfigurationsuppdateringen. Se till att ersätta platshållarna med dina egna värden som du skapade tidigare.

   Miljövariabel	Värde
   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. Exponera RESTful-API:er

Använd följande steg för att exponera dina RESTful-API:er i Microsoft Entra-ID:

1. Logga in på Azure-portalen.

2. Om du har åtkomst till flera klienter använder du filtret Katalog + prenumeration ( ) för att välja den klientorganisation där du vill registrera ett program.

3. Sök efter och markera Microsoft Entra ID.

4. Under Hantera väljer du Appregistreringar> Ny registrering.

5. Ange ett namn för ditt program i fältet Namn , till exempel Todo. Användare av din app kan se det här namnet och du kan ändra det senare.

6. För Kontotyper som stöds väljer du Konton i valfri organisationskatalog (Alla Microsoft Entra-kataloger – Flera klientorganisationer) och personliga Microsoft-konton.

7. Välj Registrera för att skapa programmet.

8. På appöversiktssidan letar du efter värdet program-ID (klient) och registrerar det för senare användning. Du behöver den för att konfigurera YAML-konfigurationsfilen för det här projektet.

9. Under Hantera väljer du Exponera ett API, letar upp program-ID-URI:n i början av sidan och väljer sedan Lägg till.

10. På sidan Redigera program-ID-URI accepterar du den föreslagna program-ID-URI:n (api://{client ID}) eller använder ett beskrivande namn i stället för klient-ID:t, till exempel api://simple-todo, och väljer sedan Spara.

11. Under Hantera väljer du Exponera ett API>Lägg till ett omfång och anger sedan följande information:

    • Som Omfångsnamn anger du ToDo.Read.
    • För Vem kan samtycka väljer du endast Administratörer.
    • För Visningsnamn för administratörsmedgivande anger du Läs ToDo-data.
    • Som Beskrivning av administratörsmedgivande anger du Tillåt autentiserade användare att läsa ToDo-data..
    • För Tillstånd behåller du det aktiverat.
    • Välj Lägg till definitionsområde.

12. Upprepa föregående steg för att lägga till de andra två omfången: ToDo.Write och ToDo.Delete.

    

3.6. Uppdatera programkonfigurationen

Använd följande steg för att uppdatera YAML-filen för att använda din Microsoft Entra-registrerade programinformation för att upprätta en relation med RESTful API-programmet:

1. Leta upp filen src/main/resources/application.yml för simple-todo-api appen. Uppdatera konfigurationen spring.cloud.azure.active-directory i avsnittet så att den matchar följande exempel. Se till att ersätta platshållarna med de värden som du skapade tidigare.

   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>
   

   Kommentar

   I v1.0-token kräver konfigurationen klient-ID för API:et, medan du i v2.0-token kan använda klient-ID:t eller program-ID:ts URI i begäran. Du kan konfigurera båda för att slutföra målgruppsverifieringen korrekt.

   De värden som tillåts för tenant-id är: common, organizations, consumerseller klientorganisations-ID. Mer information om dessa värden finns i avsnittet Använd fel slutpunkt (personliga konton och organisationskonton) i Fel AADSTS50020 – Användarkonto från identitetsprovidern finns inte i klientorganisationen. Information om hur du konverterar din app för en klientorganisation finns i Konvertera en klientorganisationsapp till flera klientorganisationer på Microsoft Entra-ID.

2. Använd följande kommando för att återskapa exempelprojektet:

   ./mvnw clean package
   

Azure Developer CLI

3.1. Förbereda Azure-resurserna

Använd följande steg för att etablera nödvändiga Azure-resurser:

1. Kör följande kommando för att logga in på Azure med OAuth2. Ignorera det här steget om du redan har loggat in.

   azd auth login
   

2. Kör följande kommando för att aktivera funktionen Azure Spring Apps:

   azd config set alpha.springapp on
   

3. Kör följande kommando för att paketera en distribuerad kopia av ditt program, etablera mallens infrastruktur till Azure och distribuera programkoden till de nyligen etablerade resurserna:

   azd provision
   

   I följande lista beskrivs kommandointeraktionerna:

   • Välj en Azure-prenumeration som ska användas: Använd pilar för att flytta, skriv för att filtrera och tryck sedan på Retur.
   • Välj en Azure-plats att använda: Använd pilar för att flytta, skriv för att filtrera och tryck sedan på Retur.

   Konsolen matar ut meddelanden som liknar följande exempel:

   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
   

   Kommentar

   Det här kommandot kan ta en stund att slutföra. Du ser en förloppsindikator när den etablerar Azure-resurser.

3.2. Exponera RESTful-API:er

Använd följande steg för att exponera dina RESTful-API:er i Microsoft Entra-ID:

1. Logga in på Azure-portalen.

2. Om du har åtkomst till flera klienter använder du filtret Katalog + prenumeration ( ) för att välja den klientorganisation där du vill registrera ett program.

3. Sök efter och markera Microsoft Entra ID.

4. Under Hantera väljer du Appregistreringar> Ny registrering.

5. Ange ett namn för ditt program i fältet Namn , till exempel Todo. Användare av din app kan se det här namnet och du kan ändra det senare.

6. För Kontotyper som stöds väljer du Konton i valfri organisationskatalog (Alla Microsoft Entra-kataloger – Flera klientorganisationer) och personliga Microsoft-konton.

7. Välj Registrera för att skapa programmet.

8. På appöversiktssidan letar du efter värdet program-ID (klient) och registrerar det för senare användning. Du behöver den för att konfigurera YAML-konfigurationsfilen för det här projektet.

9. Under Hantera väljer du Exponera ett API, letar upp program-ID-URI:n i början av sidan och väljer sedan Lägg till.

10. På sidan Redigera program-ID-URI accepterar du den föreslagna program-ID-URI:n (api://{client ID}) eller använder ett beskrivande namn i stället för klient-ID:t, till exempel api://simple-todo, och väljer sedan Spara.

11. Under Hantera väljer du Exponera ett API>Lägg till ett omfång och anger sedan följande information:

    • Som Omfångsnamn anger du ToDo.Read.
    • För Vem kan samtycka väljer du endast Administratörer.
    • För Visningsnamn för administratörsmedgivande anger du Läs ToDo-data.
    • Som Beskrivning av administratörsmedgivande anger du Tillåt autentiserade användare att läsa ToDo-data..
    • För Tillstånd behåller du det aktiverat.
    • Välj Lägg till definitionsområde.

12. Upprepa föregående steg för att lägga till de andra två omfången: ToDo.Write och ToDo.Delete.

    

3.3. Uppdatera programkonfigurationen

Använd följande steg för att uppdatera YAML-filen för att använda din Microsoft Entra-registrerade programinformation för att upprätta en relation med RESTful API-programmet:

1. Leta upp filen src/main/resources/application.yml för simple-todo-api appen. Uppdatera konfigurationen spring.cloud.azure.active-directory i avsnittet så att den matchar följande exempel. Se till att ersätta platshållarna med de värden som du skapade tidigare.

   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>
   

   Kommentar

   I v1.0-token kräver konfigurationen klient-ID för API:et, medan du i v2.0-token kan använda klient-ID:t eller program-ID:ts URI i begäran. Du kan konfigurera båda för att slutföra målgruppsverifieringen korrekt.

   De värden som tillåts för tenant-id är: common, organizations, consumerseller klientorganisations-ID. Mer information om dessa värden finns i avsnittet Använd fel slutpunkt (personliga konton och organisationskonton) i Fel AADSTS50020 – Användarkonto från identitetsprovidern finns inte i klientorganisationen. Information om hur du konverterar din app för en klientorganisation finns i Konvertera en klientorganisationsapp till flera klientorganisationer på Microsoft Entra-ID.

2. Använd följande kommando för att återskapa exempelprojektet:

   ./mvnw clean package
   

4. Distribuera appen till Azure Spring Apps

Nu kan du distribuera appen till Azure Spring Apps.

Azure Portal + Maven-plugin-program

Använd följande steg för att distribuera med maven-plugin-programmet för Azure Spring Apps:

1. Gå till den fullständiga katalogen och kör sedan följande kommando för att konfigurera appen i Azure Spring Apps:

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

   I följande lista beskrivs kommandointeraktionerna:

   • OAuth2-inloggning: Du måste auktorisera inloggningen till Azure baserat på OAuth2-protokollet.
   • Välj prenumeration: Välj prenumerationslistans nummer för den Azure Spring Apps-instans som du skapade, som standard är den första prenumerationen i listan. Om du använder standardnumret trycker du på Retur direkt.
   • Använd befintliga Azure Spring Apps i Azure: Tryck på y för att använda den befintliga Azure Spring Apps-instansen.
   • Välj Azure Spring Apps för distribution: Välj antalet Azure Spring Apps-instanser som du skapade. Om du använder standardnumret trycker du på Retur direkt.
   • Använd befintlig app i Azure Spring Apps <ditt-instansnamn>: Tryck på y för att använda den skapade appen.
   • Bekräfta för att spara alla ovanstående konfigurationer: Tryck på y. Om du trycker på n sparas inte konfigurationen i POM-filerna.

2. Använd följande kommando för att distribuera appen:

   ./mvnw azure-spring-apps:deploy
   

   I följande lista beskrivs kommandointeraktionen:

   • OAuth2-inloggning: Du måste auktorisera inloggningen till Azure baserat på OAuth2-protokollet.

   När kommandot har körts kan du se från följande loggmeddelanden att distributionen lyckades:

[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

Azure Developer CLI

Använd följande steg för att paketera appen, etablera de Azure-resurser som krävs av webbappen och sedan distribuera till Azure Spring Apps.

1. Kör följande kommando för att paketera en distribuerad kopia av ditt program:

   azd package
   

2. Kör följande kommando för att distribuera programkoden till de nyligen etablerade resurserna:

   azd deploy
   

   Konsolen matar ut meddelanden som liknar följande exempel:

   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
   

   Slutpunkten för utdata är basslutpunkten för åtkomst till ToDo API-programmet.

Kommentar

Du kan också använda azd up för att kombinera de föregående tre kommandona: azd provision (etablerar Azure-resurser), azd package (paket en distribuerad kopia av ditt program) och azd deploy (distribuerar programkod). Mer information finns i Azure-Samples/ASA-Samples-Restful-Application.

5. Verifiera appen

Nu kan du komma åt RESTful-API:et för att se om det fungerar.

5.1. Begära en åtkomsttoken

RESTful-API:erna fungerar som en resursserver, som skyddas av Microsoft Entra-ID. Innan du hämtar en åtkomsttoken måste du registrera ett annat program i Microsoft Entra-ID och bevilja behörigheter till klientprogrammet, som heter ToDoWeb.

Registrera klientprogrammet

Använd följande steg för att registrera ett program i Microsoft Entra-ID, som används för att lägga till behörigheter för ToDo appen:

1. Logga in på Azure-portalen.

2. Om du har åtkomst till flera klienter använder du filtret Katalog + prenumeration ( ) för att välja den klientorganisation där du vill registrera ett program.

3. Sök efter och markera Microsoft Entra ID.

4. Under Hantera väljer du Appregistreringar> Ny registrering.

5. Ange ett namn för ditt program i fältet Namn , till exempel ToDoWeb. Användare av din app kan se det här namnet och du kan ändra det senare.

6. För kontotyper som stöds använder du endast standardvärdet Konton i den här organisationskatalogen.

7. Välj Registrera för att skapa programmet.

8. På appöversiktssidan letar du efter värdet program-ID (klient) och registrerar det för senare användning. Du behöver den för att hämta en åtkomsttoken.

9. Välj API-behörigheter>Lägg till en behörighet>Mina API:er. Välj det ToDo program som du registrerade tidigare och välj sedan behörigheterna ToDo.Read, ToDo.Write och ToDo.Delete . Välj Lägg till behörigheter.

10. Välj Bevilja administratörsmedgivande för ditt klientnamn> för <att bevilja administratörsmedgivande för de behörigheter som du har lagt till.

    

Lägg till användare för att komma åt RESTful-API:er

Använd följande steg för att skapa en medlemsanvändare i din Microsoft Entra-klientorganisation. Sedan kan användaren hantera programmets ToDo data via RESTful-API:er.

1. Under Hantera väljer du Användare>Ny användare>Skapa ny användare.

2. På sidan Skapa ny användare anger du följande information:

   • Användarens huvudnamn: Ange ett namn för användaren.
   • Visningsnamn: Ange ett visningsnamn för användaren.
   • Lösenord: Kopiera det automatiskt genererade lösenordet som anges i rutan Lösenord .

   Kommentar

   Nya användare måste slutföra den första inloggningsautentiseringen och uppdatera sina lösenord, annars får du ett AADSTS50055: The password is expired fel när du får åtkomsttoken.

   När en ny användare loggar in får de en uppmaning om åtgärd som krävs . De kan välja Fråga senare för att hoppa över valideringen.

3. Välj Granska + skapa för att granska dina val. Välj Skapa för att skapa användaren.

Uppdatera OAuth2-konfigurationen för Swagger UI-auktorisering

Använd följande steg för att uppdatera OAuth2-konfigurationen för Swagger UI-auktorisering. Sedan kan du auktorisera användare att hämta åtkomsttoken via ToDoWeb appen.

1. Öppna din Microsoft Entra ID-klientorganisation i Azure Portal och gå till den registrerade ToDoWeb appen.

2. Under Hantera väljer du Autentisering, lägger till en plattform och väljer sedan Ensidesprogram.

3. Använd formatet <your-app-exposed-application-URL-or-endpoint>/swagger-ui/oauth2-redirect.html som omdirigerings-URL för OAuth2 i fältet Omdirigerings-URI:er och välj sedan Konfigurera.

   

Hämta åtkomsttoken

Använd följande steg för att använda OAuth 2.0-auktoriseringskodflödesmetoden för att hämta en åtkomsttoken med Microsoft Entra-ID och sedan komma åt appens RESTful-API:er ToDo :

1. Öppna url:en som exponeras av appen och välj sedan Auktorisera för att förbereda OAuth2-autentiseringen.

2. I fönstret Tillgängliga auktoriseringar anger du appens klient-ID ToDoWeb i fältet client_id, markerar alla omfång för fältet Omfång, ignorerar fältet client_secret och väljer sedan Auktorisera för att omdirigera till Microsoft Entra-inloggningssidan.

När du har slutfört inloggningen med den tidigare användaren återgår du till fönstret Tillgängliga auktoriseringar .

5.2. Få åtkomst till RESTful-API:erna

Använd följande steg för att komma åt RESTful-API:erna för ToDo appen i Swagger-användargränssnittet:

1. Välj API POST /api/simple-todo/lists och välj sedan Prova. Ange följande begärandetext och välj sedan Kör för att skapa en ToDo-lista.

   {
     "name": "My List"
   }
   

   När körningen är klar visas följande svarstext:

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

2. Välj API POST /api/simple-todo/lists/{listId}/items och välj sedan Prova. För listId anger du det ToDo-list-ID som du skapade tidigare, anger följande begärandetext och väljer sedan Kör för att skapa ett ToDo-objekt.

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

   Den här åtgärden returnerar följande ToDo-objekt:

   {
     "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. Välj API GET /api/simple-todo/lists och välj sedan Kör för att fråga ToDo-listor. Den här åtgärden returnerar följande ToDo-listor:

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

4. Välj API GET /api/simple-todo/lists/{listId}/items och välj sedan Prova. För listId anger du det ToDo-list-ID som du skapade tidigare och väljer sedan Kör för att köra frågor mot ToDo-objekten. Den här åtgärden returnerar följande ToDo-objekt:

   [
     {
       "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. Välj API PUT /api/simple-todo/lists/{listId}/items/{itemId} och välj sedan Prova. För listId anger du todo-list-ID. För itemId anger du Objekt-ID för ToDo, anger följande begärandetext och väljer sedan Kör för att uppdatera ToDo-objektet.

   {
     "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"
   }
   

   Den här åtgärden returnerar följande uppdaterade ToDo-objekt:

   {
     "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. Välj API DELETE /api/simple-todo/lists/{listId}/items/{itemId} och välj sedan Prova. För listId anger du todo-list-ID. För itemId anger du Objekt-ID för ToDo och väljer sedan Kör för att ta bort ToDo-objektet. Du bör se att serverns svarskod är 204.

6. Rensa resurser

Du kan ta bort den Azure-resursgrupp som innehåller alla resurser i resursgruppen.

Azure Portal + Maven-plugin-program

Använd följande steg för att ta bort hela resursgruppen, inklusive den nyligen skapade tjänsten:

1. Leta reda på resursgruppen på Azure Portal.

2. På navigeringsmenyn väljer du Resursgrupper. Välj sedan namnet på resursgruppen , till exempel myresourcegroup.

3. Välj Ta bort på din resursgruppssida. Ange namnet på resursgruppen i textrutan för att bekräfta borttagningen, till exempel myresourcegroup. Välj sedan Ta bort.

Azure CLI

Använd följande kommando för att ta bort hela resursgruppen, inklusive den nyligen skapade tjänsten:

az group delete --name ${RESOURCE_GROUP}

Azure Portal + Maven-plugin-program

Använd följande steg för att ta bort hela resursgruppen, inklusive den nyligen skapade tjänsten:

1. Leta reda på resursgruppen på Azure Portal.

2. På navigeringsmenyn väljer du Resursgrupper. Välj sedan namnet på resursgruppen , till exempel myresourcegroup.

3. Välj Ta bort på din resursgruppssida. Ange namnet på resursgruppen i textrutan för att bekräfta borttagningen, till exempel myresourcegroup. Välj sedan Ta bort.

Azure Developer CLI

Använd följande kommando för att ta bort alla Azure-resurser som används i det här exempelprogrammet:

azd down

I följande lista beskrivs kommandointeraktionen:

• Totalt antal resurser att ta bort: [your-resources-total], är du säker på att du vill fortsätta?: Tryck på y.

Konsolen matar ut meddelanden som liknar följande exempel:

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

7. Nästa steg

Snabbstart: Distribuera ett händelsedrivet program till Azure Spring Apps

Snabbstart: Distribuera mikrotjänstprogram till Azure Spring Apps

Strukturerad programlogg för Azure Spring Apps

Mappa en befintlig anpassad domän till Azure Spring Apps

Använda Azure Spring Apps CI/CD med GitHub Actions

Automatisera programdistributioner till Azure Spring Apps

Mer information finns i följande artiklar:

• Azure Spring Apps-exempel.
• Spring på Azure
• Spring Cloud Azure