Exercice : Créer et utiliser un module

Effectué

Vous êtes chargé d’ajouter un réseau de distribution de contenu, ou CDN, au site web de votre entreprise pour le lancement d’un jouet Wombat. Toutefois, d’autres équipes de votre entreprise n’ont pas besoin d’un CDN. Dans cet exercice, vous créez des modules pour le site web et le CDN, et vous ajoutez les modules à un modèle.

Pendant ce processus, vous allez :

• Ajouter un module pour votre application.
• Créer un modèle Bicep qui utilise le module.
• Ajouter un autre module pour le CDN.
• Ajouter le module CDN à votre modèle, tout en le rendant facultatif.
• Déployez le modèle sur Azure
• Passer en revue l’historique de déploiement.

Note

Cet exercice est facultatif. Si vous souhaitez effectuer cet exercice, vous devez créer un abonnement Azure avant de commencer. Si vous n’avez pas de compte Azure ou si vous ne souhaitez pas en créer un à ce stade, vous pouvez lire les instructions pour comprendre les informations qui sont présentées.

Cet exercice utilise l’extension Bicep pour Visual Studio Code. Veillez à installer cette extension dans Visual Studio Code.

Note

Vous devez utiliser un groupe de ressources pour effectuer les étapes de cet exercice. Vous pouvez utiliser un groupe de ressources que vous avez déjà créé, ou vous pouvez créer un groupe de ressources spécifiquement pour cet exercice. Si vous choisissez de créer un groupe de ressources, cela facilite le nettoyage des ressources que vous créez lorsque vous effectuez l’exercice. Si vous n’avez pas de groupe de ressources existant ou si vous souhaitez en créer un spécifiquement pour cet exercice, vous pouvez suivre les étapes décrites dans Utiliser le portail Azure et Azure Resource Manager pour gérer les groupes de ressources pour créer un groupe de ressources à l’aide du portail Azure, ou vous pouvez suivre les étapes décrites dans Gérer les groupes de ressources Azure à l’aide d’Azure CLI pour créer un groupe de ressources à l’aide de l’interface Azure CLI.

Note

Tout au long de cet exercice, remplacez myResourceGroupName dans les exemples par le nom d’un groupe de ressources existant ou le nom du groupe de ressources que vous avez créé pour cet exercice.

Créer un fichier Bicep vide

1. Ouvrez Visual Studio Code.

2. Créez un fichier nommé main.bicep.

3. Enregistrez le fichier vide afin que Visual Studio Code charge les outils Bicep.

   Vous pouvez sélectionner Fichier>Enregistrer sous ou Ctrl+S sur Windows (⌘+S sur macOS). Assurez-vous de bien noter l’emplacement où le fichier est enregistré. Par exemple, vous pouvez créer un dossier templates où l’enregistrer.

Créer un module pour votre application

1. Créez un dossier appelé modules dans le même dossier où vous avez créé votre fichier main.bicep. Dans le dossier modules, créez un fichier nommé app.bicep. Enregistrez le fichier.

2. Ajoutez le contenu suivant dans le fichier app.bicep :

   @description('The Azure region into which the resources should be deployed.')
   param location string
   
   @description('The name of the App Service app.')
   param appServiceAppName string
   
   @description('The name of the App Service plan.')
   param appServicePlanName string
   
   @description('The name of the App Service plan SKU.')
   param appServicePlanSkuName string
   
   resource appServicePlan 'Microsoft.Web/serverfarms@2024-04-01' = {
     name: appServicePlanName
     location: location
     sku: {
       name: appServicePlanSkuName
     }
   }
   
   resource appServiceApp 'Microsoft.Web/sites@2024-04-01' = {
     name: appServiceAppName
     location: location
     properties: {
       serverFarmId: appServicePlan.id
       httpsOnly: true
     }
   }
   
   @description('The default host name of the App Service app.')
   output appServiceAppHostName string = appServiceApp.properties.defaultHostName
   

   Ce fichier déploie un plan Azure App Service et une application. Notez que le module est relativement générique. Il ne comprend pas d’hypothèses sur les noms de ressources ou la référence SKU du plan App Service. Cela facilite la réutilisation du module pour différents déploiements.

3. Enregistrez les modifications du fichier.

Ajouter le module à votre modèle Bicep

Ici, vous ajoutez le module app à votre modèle Bicep comme point de départ.

1. Ouvrez le fichier main.bicep.

2. Ajoutez les paramètres et la variable suivants au fichier :

   @description('The Azure region into which the resources should be deployed.')
   param location string = 'westus3'
   
   @description('The name of the App Service app.')
   param appServiceAppName string = 'toy-${uniqueString(resourceGroup().id)}'
   
   @description('The name of the App Service plan SKU.')
   param appServicePlanSkuName string = 'F1'
   
   var appServicePlanName = 'toy-product-launch-plan'
   

   Comme il s’agit du modèle que vous avez l’intention de déployer pour vos sites web de jouets, il est un peu plus spécifique. Le nom du plan App Service est défini sous forme de variable. Le paramètre de référence SKU a une valeur par défaut qui est logique pour le site web de lancement du jouet.

3. Sous les paramètres, créez une ligne vide. À présent, tapez la première ligne de la définition du module app :

   module app 'modules/app.bicep' = {
   

   Quand vous tapez, vous remarquez que l’extension Bicep pour Visual Studio Code vous aide à construire la déclaration de module. Quand vous tapez le chemin de votre module et le caractère égal (=), un menu contextuel s’affiche avec plusieurs options.

4. Sélectionnez les Propriétés obligatoires dans le menu contextuel :

   

5. Complétez la déclaration du module :

   module app 'modules/app.bicep' = {
     name: 'toy-launch-app'
     params: {
       appServiceAppName: appServiceAppName
       appServicePlanName: appServicePlanName
       appServicePlanSkuName: appServicePlanSkuName
       location: location
     }
   }
   

6. En bas du fichier, définissez une sortie :

   @description('The host name to use to access the website.')
   output websiteHostName string = app.outputs.appServiceAppHostName
   

7. Enregistrez les modifications du fichier.

Créer un module pour le réseau de distribution de contenu

1. Dans le dossier modules, créez un fichier nommé cdn.bicep. Enregistrez le fichier.

2. Ajoutez le contenu suivant dans le fichier cdn.bicep :

   @description('The host name (address) of the origin server.')
   param originHostName string
   
   @description('The name of the CDN profile.')
   param profileName string = 'cdn-${uniqueString(resourceGroup().id)}'
   
   @description('The name of the CDN endpoint')
   param endpointName string = 'endpoint-${uniqueString(resourceGroup().id)}'
   
   @description('Indicates whether the CDN endpoint requires HTTPS connections.')
   param httpsOnly bool
   
   var originName = 'my-origin'
   
   resource cdnProfile 'Microsoft.Cdn/profiles@2024-09-01' = {
     name: profileName
     location: 'global'
     sku: {
       name: 'Standard_Microsoft'
     }
   }
   
   resource endpoint 'Microsoft.Cdn/profiles/endpoints@2024-09-01' = {
     parent: cdnProfile
     name: endpointName
     location: 'global'
     properties: {
       originHostHeader: originHostName
       isHttpAllowed: !httpsOnly
       isHttpsAllowed: true
       queryStringCachingBehavior: 'IgnoreQueryString'
       contentTypesToCompress: [
         'text/plain'
         'text/html'
         'text/css'
         'application/x-javascript'
         'text/javascript'
       ]
       isCompressionEnabled: true
       origins: [
         {
           name: originName
           properties: {
             hostName: originHostName
           }
         }
       ]
     }
   }
   
   @description('The host name of the CDN endpoint.')
   output endpointHostName string = endpoint.properties.hostName
   

   Ce fichier déploie deux ressources : un profil CDN et un point de terminaison CDN.

3. Enregistrez les modifications du fichier.

Ajouter les modules au modèle Bicep main

1. Ouvrez le fichier main.bicep.

2. Sous le paramètre appServicePlanSkuName, ajoutez les paramètres suivants :

   @description('Indicates whether a CDN should be deployed.')
   param deployCdn bool = true
   

3. Sous la définition du module app, définissez le module cdn :

   module cdn 'modules/cdn.bicep' = if (deployCdn) {
     name: 'toy-launch-cdn'
     params: {
       httpsOnly: true
       originHostName: app.outputs.appServiceAppHostName
     }
   }
   

   Notez que le module a une condition afin de pouvoir être déployé uniquement quand la valeur du paramètre deployCdn est définie sur true. Notez également que le paramètre originHostName du module est défini sur la valeur de la sortie appServiceAppHostName du module app.

4. Mettez à jour la sortie du nom d’hôte pour qu’elle sélectionne le nom d’hôte approprié. Quand un CDN est déployé, vous voulez que le nom d’hôte soit celui du point de terminaison CDN.

   output websiteHostName string = deployCdn ? cdn.outputs.endpointHostName : app.outputs.appServiceAppHostName
   

5. Enregistrez les modifications du fichier.

Vérifier votre fichier Bicep

Une fois que vous avez terminé toutes les modifications précédentes, votre fichier main.bicep doit ressembler à cet exemple :

@description('The Azure region into which the resources should be deployed.')
param location string = 'westus3'

@description('The name of the App Service app.')
param appServiceAppName string = 'toy-${uniqueString(resourceGroup().id)}'

@description('The name of the App Service plan SKU.')
param appServicePlanSkuName string = 'F1'

@description('Indicates whether a CDN should be deployed.')
param deployCdn bool = true

var appServicePlanName = 'toy-product-launch-plan'

module app 'modules/app.bicep' = {
  name: 'toy-launch-app'
  params: {
    appServiceAppName: appServiceAppName
    appServicePlanName: appServicePlanName
    appServicePlanSkuName: appServicePlanSkuName
    location: location
  }
}

module cdn 'modules/cdn.bicep' = if (deployCdn) {
  name: 'toy-launch-cdn'
  params: {
    httpsOnly: true
    originHostName: app.outputs.appServiceAppHostName
  }
}

@description('The host name to use to access the website.')
output websiteHostName string = deployCdn ? cdn.outputs.endpointHostName : app.outputs.appServiceAppHostName

Si ce n’est pas le cas, copiez l’exemple ou ajustez votre modèle pour qu’il corresponde à l’exemple.

Déployer le modèle Bicep sur Azure

Pour déployer ce modèle sur Azure, vous devez vous connecter à votre compte Azure à partir du terminal Visual Studio Code. Vérifiez que vous avez installé les outils Azure CLI .

1. Dans le menu Terminal, sélectionnez Nouveau terminal. La fenêtre de terminal s’ouvre généralement dans la moitié inférieure de votre écran.

2. Si la fenêtre de terminal affiche bash sur le côté droit, cela signifie que l’interpréteur de commandes approprié est déjà ouvert. Autrement, si vous voyez une icône d’interpréteur de commandes bash à droite, vous pouvez la sélectionner pour lancer l’interpréteur de commandes.

   

   Si un interpréteur de commandes autre que bash apparaît, sélectionnez la flèche déroulante des interpréteurs de commandes, puis Git Bash.

   

3. Dans le terminal, accédez au répertoire où vous avez enregistré votre modèle. Par exemple, si vous avez enregistré votre modèle dans le dossier templates, vous pouvez utiliser la commande suivante :

   cd templates
   

Installer Bicep

Exécutez la commande suivante pour vous assurer de disposer de la dernière version de Bicep :

az bicep install && az bicep upgrade

Se connecter à Azure à l’aide d’Azure CLI

1. Dans le terminal Visual Studio Code, connectez-vous à Azure en exécutant la commande suivante :

   az login
   

2. Dans le navigateur qui s’ouvre, connectez-vous à votre compte Azure.

   Le terminal Visual Studio Code affiche la liste des abonnements associés à ce compte.

3. Dans la liste, recherchez l’abonnement que vous souhaitez utiliser pour cet exercice.

   Si vous avez manqué la liste à partir de la connexion, vous pouvez utiliser l’extrait de code suivant pour répertorier à nouveau vos abonnements.

   az account list --output table
   

4. Définissez l’abonnement par défaut pour toutes les commandes Azure CLI que vous exécutez dans cette session.

   az account set --subscription "Your Subscription Name or ID"
   

Déployer le modèle sur Azure

Exécutez le code suivant à partir du terminal dans Visual Studio Code pour déployer le modèle Bicep sur Azure. Ce processus peut prendre une minute ou deux, puis vous voyez que le déploiement a réussi.

az deployment group create --name main --template-file main.bicep

L’état Running... apparaît dans le terminal.

Pour déployer ce modèle sur Azure, connectez-vous à votre compte Azure dans le terminal Visual Studio Code. Vérifiez que vous avez installé Azure PowerShell.

1. Dans le menu Terminal, sélectionnez Nouveau terminal. La fenêtre de terminal s’ouvre généralement dans la moitié inférieure de votre écran.

2. Si la fenêtre de terminal affiche pwsh ou powershell sur le côté droit, cela signifie que l’interpréteur de commandes approprié est déjà ouvert. Autrement, si vous voyez une icône d’interpréteur de commandes PowerShell à droite, vous pouvez la sélectionner pour lancer l’interpréteur de commandes.

   

   Si un interpréteur de commandes autre que pwsh ou powershell apparaît, sélectionnez la flèche déroulante de l’interpréteur de commandes, puis PowerShell.

   

3. Dans le terminal, accédez au répertoire où vous avez enregistré votre modèle. Par exemple, si vous avez enregistré votre modèle dans le dossier templates, vous pouvez utiliser la commande suivante :

   Set-Location -Path templates
   

Installer l’interface CLI Bicep

Pour utiliser Bicep à partir d’Azure PowerShell, installez l’interface CLI de Bicep.

Connectez-vous à Azure en utilisant Azure PowerShell

1. Dans le terminal Visual Studio Code, connectez-vous à Azure en exécutant la commande suivante :

   Connect-AzAccount
   

2. Dans le navigateur qui s’ouvre, connectez-vous à votre compte Azure.

3. Obtenez l’ID de l’abonnement que vous souhaitez utiliser pour cet exercice en exécutant la commande suivante :

   Get-AzSubscription
   

   L’ID d’abonnement est la deuxième colonne. Copiez la deuxième colonne. Il ressemble à aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e4e4e.

4. Définissez l’abonnement par défaut pour toutes les commandes Azure PowerShell que vous exécutez dans cette session.

   Set-AzContext -SubscriptionId {Your subscription ID}
   

Déployer le modèle sur Azure

Déployez le modèle sur Azure en utilisant la commande Azure PowerShell dans le terminal. Ce processus peut prendre une minute ou deux, puis vous voyez que le déploiement a réussi.

New-AzResourceGroupDeployment -Name main -TemplateFile main.bicep

Passer en revue l’historique de déploiement

1. Connectez-vous au portail Azure et vérifiez que vous utilisez l’abonnement approprié :

   1. Sélectionnez votre avatar dans le coin supérieur droit de la page.
   2. Sélectionnez Changer de répertoire. Dans la liste, choisissez le répertoire approprié.

2. Dans le volet de gauche, sélectionnez Groupes de ressources.

3. Sélectionnez myResourceGroupName.

4. Dans le menu de gauche, sélectionnez Déploiements sous Paramètres.

   

   Trois déploiements sont listés.

5. Sélectionnez le déploiement main et développez Détails du déploiement.

   Notez que les deux modules sont listés et que leurs types sont affichés comme Microsoft.Resources/deployments. Les modules sont listés deux fois parce que leurs sorties sont également référencées dans le modèle.

   

6. Sélectionnez les déploiements toy-launch-cdn et toy-launch-app, puis passez en revue les ressources déployées dans chacun d’eux. Notez qu’elles correspondent aux ressources définies dans le module respectif.

Tester le site web

1. Sélectionnez le déploiement toy-launch-app.

2. Sélectionnez Sorties.

   

3. Sélectionnez le bouton de copie pour la sortie appServiceAppHostName.

4. Sous un nouvel onglet de navigateur, essayez d’accéder à l’adresse que vous avez copiée à l’étape précédente. L’adresse doit commencer par https://.

   

   La page d’accueil App Service s’affiche, indiquant que vous avez correctement déployé l’application.

5. Accédez au déploiement main et sélectionnez Sorties.

6. Copiez la valeur de la sortie websiteHostName. Notez que ce nom d’hôte est différent, car il s’agit d’un nom d’hôte Azure Content Delivery Network.

7. Sous un nouvel onglet de navigateur, essayez d’accéder au nom d’hôte que vous avez copié à l’étape précédente. Ajoutez https:// au début de l’adresse.

   Les points de terminaison CDN sont actifs au bout de quelques minutes. Si vous obtenez une erreur Page introuvable, attendez quelques minutes et réessayez de coller le lien. Par ailleurs, veillez à ajouter https:// au début de l’URL pour utiliser le protocole HTTPS.

   Quand le point de terminaison CDN est actif, vous obtenez la même page d’accueil App Service. Cette fois, elle a été servie par le service Azure Content Delivery Network, qui permet d’améliorer les performances du site web.