Exercice – définir des ressources enfants

Effectué

Notes

La première fois que vous activez un bac à sable et que vous acceptez les conditions d’utilisation, votre compte Microsoft est associé à un nouveau répertoire Azure appelé Microsoft Learn Sandbox (bac à sable Microsoft Learn). Vous êtes également ajouté à un abonnement spécial nommé Abonnement Concierge.

Vous commencez à travailler sur les requêtes de votre équipe R&D et vous décidez de commencer par créer une base de données Azure Cosmos DB pour les données de test du drone-jouet. Dans cet exercice, vous crée le compte Azure Cosmos DB et deux ressources enfants, l’une à l’aide de la propriété parent et l’autre en tant que ressource imbriquée.

Pendant ce processus :

  • Créez un fichier Bicep qui déploie un compte Cosmos DB.
  • Ajoutez une base de données et un conteneur, qui sont des ressources enfants du compte Cosmos DB.
  • Déployez le modèle et vérifiez le déploiement.

Cet exercice utilise l’extension Bicep pour Visual Studio Code. Assurez-vous d’installer cette extension dans Visual Studio Code.

Créer un modèle Bicep qui contient un compte Azure Cosmos DB

Tout d’abord, vous créez un nouveau modèle Bicep avec un compte Azure Cosmos DB. Pour cela, procédez de la façon suivante :

  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 soit sélectionner Fichier>Enregistrer sous, soit appuyer sur Ctrl+S dans Windows (⌘+S sur macOS). Assurez-vous de bien noter l’emplacement de sauvegarde du fichier. Vous pouvez par exemple créer un dossier scripts pour l’y enregistrer.

  4. Ajoutez le contenu suivant au fichier. Il est judicieux de l’entrer manuellement plutôt que d’effectuer un copier-coller. De cette façon, vous pouvez voir comment les outils vous aident à écrire vos fichiers Bicep.

    param cosmosDBAccountName string = 'toyrnd-${uniqueString(resourceGroup().id)}'
    param location string = resourceGroup().location
    
    resource cosmosDBAccount 'Microsoft.DocumentDB/databaseAccounts@2024-05-15' = {
      name: cosmosDBAccountName
      location: location
      properties: {
        databaseAccountOfferType: 'Standard'
        locations: [
          {
            locationName: location
          }
        ]
      }
    }
    

    Conseil

    Bicep est strict quant à l’emplacement des sauts de ligne. Veillez donc à ajouter des sauts de ligne uniquement comme indiqué ici.

    Ce modèle Bicep déploie un compte Azure Cosmos DB qui est la ressource parente à générer dans la section suivante.

  5. Enregistrez les modifications du fichier.

Ajouter une base de données

Ensuite, vous créez la base de données, qui est une ressource enfant du compte Azure Cosmos DB.

  1. En haut du fichier, entre les deux paramètres existants, ajoutez le paramètre suivant :

    param cosmosDBDatabaseThroughput int = 400
    
  2. Dans les déclarations de paramètre, ajoutez la variable suivante :

    var cosmosDBDatabaseName = 'FlightTests'
    
  3. Ajoutez la définition de ressource suivante au bas du fichier, sous la définition de ressource de compte Azure Cosmos DB.

    resource cosmosDBDatabase 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-05-15' = {
      parent: cosmosDBAccount
      name: cosmosDBDatabaseName
      properties: {
        resource: {
          id: cosmosDBDatabaseName
        }
        options: {
          throughput: cosmosDBDatabaseThroughput
        }
      }
    }
    

    Notez que ce code déploie la base de données, qui est une ressource enfant, à l’aide de la propriété parent. Remarquez également que le code utilise le type de ressource complet, avec la version de l’API spécifié explicitement.

  4. Enregistrez les modifications du fichier.

Ajouter un conteneur

Vous ajoutez maintenant une autre ressource enfant. Cette fois, vous l’ajoutez en tant que ressource imbriquée plutôt que l’utilisation de la propriété parent.

  1. Vers le haut du fichier, sous la définition de la variable cosmosDBDatabaseName, ajoutez les variables suivantes :

    var cosmosDBContainerName = 'FlightTests'
    var cosmosDBContainerPartitionKey = '/droneId'
    
  2. Dans le bas du fichier, dans la définition de ressource de base de données et avant l’accolade fermante (}), ajoutez la définition de ressource imbriquée suivante :

    resource container 'containers' = {
      name: cosmosDBContainerName
      properties: {
        resource: {
          id: cosmosDBContainerName
          partitionKey: {
            kind: 'Hash'
            paths: [
              cosmosDBContainerPartitionKey
            ]
          }
        }
        options: {}
      }
    }
    

    Remarquez que vous avez utilisé un type de ressource court, containers, car Bicep comprend qu’il appartient au type de ressource parent. Bicep sait que le type de la ressource complet est Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers. Vous n’avez pas spécifié une version d’API. Bicep utilise donc la version de la ressource parent, 2020-04-01.

    Quand vous avez terminé, votre modèle Bicep entier doit ressembler à cet exemple :

    param cosmosDBAccountName string = 'toyrnd-${uniqueString(resourceGroup().id)}'
    param cosmosDBDatabaseThroughput int = 400
    param location string = resourceGroup().location
    
    var cosmosDBDatabaseName = 'FlightTests'
    var cosmosDBContainerName = 'FlightTests'
    var cosmosDBContainerPartitionKey = '/droneId'
    
    resource cosmosDBAccount 'Microsoft.DocumentDB/databaseAccounts@2024-05-15' = {
      name: cosmosDBAccountName
      location: location
      properties: {
        databaseAccountOfferType: 'Standard'
        locations: [
          {
            locationName: location
          }
        ]
      }
    }
    
    resource cosmosDBDatabase 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-05-15' = {
      parent: cosmosDBAccount
      name: cosmosDBDatabaseName
      properties: {
        resource: {
          id: cosmosDBDatabaseName
        }
        options: {
          throughput: cosmosDBDatabaseThroughput
        }
      }
    
      resource container 'containers' = {
        name: cosmosDBContainerName
        properties: {
          resource: {
            id: cosmosDBContainerName
            partitionKey: {
              kind: 'Hash'
              paths: [
                cosmosDBContainerPartitionKey
              ]
            }
          }
          options: {}
        }
      }
    }
    
  3. Enregistrez les modifications du fichier.

Déployer le modèle sur Azure

Pour déployer ce modèle sur Azure, vous devez vous connecter à votre compte Azure à partir du terminal Visual Studio Code. Veillez à installer Azure CLI sans oublier de vous connecter avec le même compte que celui utilisé pour activer le bac à sable.

  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 l’interpréteur de commandes affiché sur le côté droit de la fenêtre de terminal est bash, il s’agit du bon interpréteur de commandes qui est ouvert et vous pouvez passer à la section suivante.

    Capture d’écran de la fenêtre de terminal Visual Studio Code avec l’option bash affichée.

  3. Si un interpréteur de commandes autre que bash apparaît, sélectionnez la flèche déroulante des interpréteurs de commandes, puis Azure Cloud Shell (Bash).

    Capture d’écran de la fenêtre de terminal Visual Studio Code avec la liste déroulante de l’interpréteur de commande affichée et l’option Git Bash par défaut sélectionnée.

  4. Dans la liste des interpréteurs de commandes de terminal, sélectionnez bash.

    Capture d’écran de la fenêtre de terminal Visual Studio Code avec le terminal bash sélectionné.

  5. 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

Connexion à Azure

  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. Définissez l’abonnement par défaut pour toutes les commandes Azure CLI que vous exécutez dans cette session.

    az account set --subscription "Concierge Subscription"
    

    Notes

    Si vous avez utilisé plusieurs bacs à sable récemment, le terminal risque d’afficher plusieurs instances de l’abonnement Concierge. Dans ce cas, utilisez les deux étapes suivantes pour en définir un comme l’abonnement par défaut. Si la commande précédente a réussi et qu’un seul abonnement Concierge est listé, ignorez les deux étapes suivantes.

  4. Obtenez les ID des abonnements Concierge.

     az account list \
       --refresh \
       --query "[?contains(name, 'Concierge Subscription')].id" \
       --output table
    
  5. Définissez l’abonnement par défaut en utilisant l’ID d’abonnement. Remplacez {your subscription ID} par l’ID du dernier abonnement Concierge.

    az account set --subscription {your subscription ID}
    

Définir le groupe de ressources par défaut

Quand vous utilisez Azure CLI, vous pouvez définir le groupe de ressources par défaut et omettre le paramètre du reste des commandes Azure CLI dans cet exercice. Définissez le paramètre par défaut sur le groupe de ressources qui est créé pour vous dans l’environnement de bac à sable.

az configure --defaults group="<rgn>[sandbox resource group name]</rgn>"

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. Cette opération peut prendre une minute ou deux avant l’affichage d’un déploiement réussi.

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

Pour déployer ce modèle sur Azure, connectez-vous à votre compte Azure à partir du terminal Visual Studio Code. Vérifiez que vous avez installé Azure PowerShell et connectez-vous au même compte que celui qui a activé le bac à sable.

  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 l’interpréteur de commandes affiché sur le côté droit de la fenêtre de terminal est powershell ou pwsh, il s’agit du bon interpréteur de commandes qui est ouvert et vous pouvez passer à la section suivante.

    Capture d’écran de la fenêtre de terminal Visual Studio Code, avec l’option pwsh indiquée dans la liste déroulante de l’interpréteur de commande.

  3. Si un shell autre que powershell ou pwsh apparaît, sélectionnez la flèche déroulante des interpréteurs de commandes, puis PowerShell.

    Capture d’écran de la fenêtre de terminal Visual Studio Code avec la liste déroulante de l’interpréteur de commande affichée avec PowerShell sélectionné.

  4. Dans la liste d’interpréteurs de commandes de terminal, sélectionnez powershell ou pwsh.

    Capture d’écran de la fenêtre de terminal Visual Studio Code avec le terminal PowerShell sélectionné.

  5. 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, exécutez la commande suivante :

    Connect-AzAccount
    

    Un navigateur s’ouvre pour vous permettre de vous connecter à votre compte Azure.

  2. Une fois que vous êtes connecté à Azure, le terminal affiche une liste des abonnements associés à ce compte.

    Si vous avez activé le bac à sable, un abonnement appelé Abonnement Concierge s’affiche. Utilisez-le pour le reste de l’exercice.

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

    $context = Get-AzSubscription -SubscriptionName 'Concierge Subscription'
    Set-AzContext $context
    

    Notes

    Si vous avez utilisé plusieurs bacs à sable récemment, le terminal risque d’afficher plusieurs instances de l’abonnement Concierge. Dans ce cas, utilisez les deux étapes suivantes pour en définir un comme l’abonnement par défaut. Si la commande précédente a réussi et qu’un seul abonnement Concierge est listé, ignorez les deux étapes suivantes.

  4. Obtenir l’ID d’abonnement. L’exécution de la commande suivante liste vos abonnements et leurs ID. Recherchez Concierge Subscription, puis copiez l’ID de la deuxième colonne. Il doit ressembler à ceci : aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e.

    Get-AzSubscription
    
  5. Remplacez votre abonnement actif par l’abonnement Concierge. Veillez à remplacer {Votre ID d’abonnement} par celui que vous avez copié.

    $context = Get-AzSubscription -SubscriptionId {Your subscription ID}
    Set-AzContext $context
    

Définir votre groupe de ressources par défaut

Vous pouvez définir le groupe de ressources par défaut et omettre le paramètre du reste des commandes Azure PowerShell dans cet exercice. Définissez ce paramètre par défaut sur le groupe de ressources créé pour vous dans l’environnement de bac à sable.

Set-AzDefault -ResourceGroupName <rgn>[sandbox resource group name]</rgn>

Déployer le modèle sur Azure

Déployez le modèle sur Azure en utilisant la commande Azure PowerShell dans le terminal. Cette opération peut prendre une minute ou deux avant l’affichage d’un déploiement réussi.

New-AzResourceGroupDeployment -TemplateFile main.bicep

Vérifier le déploiement

  1. Accédez au portail Azure et vérifiez que vous êtes bien dans l’abonnement de bac à sable :

    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 Bac à sable Microsoft Learn.

  2. Sur la page d’accueil, sélectionnez Groupes de ressources. Le volet Groupes de ressources s’affiche.

  3. Sélectionnez [nom du groupe de ressources du bac à sable].

  4. Dans la Vue d’ensemble, vous voyez qu’un déploiement a réussi.

    Capture d’écran de l’interface du portail Azure pour la vue d’ensemble du groupe de ressources avec la section Déploiements montrant qu’un déploiement a réussi.

  5. Sélectionnez 1 réussi pour afficher les détails du déploiement.

    Capture d’écran de l’interface du portail Azure pour les déploiements montrant un déploiement répertorié avec un état réussi.

  6. Sélectionnez le déploiement appelé main pour voir quelles ressources ont été déployées, puis sélectionnez Détails du déploiement pour le développer. Dans ce cas, un compte Cosmos DB, une base de données et un conteneur sont répertoriés.

    Capture d’écran de l’interface du portail Azure pour le déploiement spécifique avec trois ressources Cosmos DB répertoriées.

  7. Laissez la page ouverte dans votre navigateur afin de pouvoir vérifier les déploiements ultérieurement.