Configuration de l’hôte d’application

Article
13/12/2024

Le projet hôte d’application configure et démarre votre application distribuée (DistributedApplication). Lorsqu’un DistributedApplication l’exécute, il lit la configuration à partir de l’hôte de l’application. La configuration est chargée à partir de variables d’environnement définies sur l’hôte de l’application et DistributedApplicationOptions.

La configuration inclut :

Paramètres d’hébergement du service de ressources, tels que les options d’adresse et d’authentification.
Paramètres utilisés pour démarrer le tableau de bord .NET.NET Aspire, tels que le front-end du tableau de bord et les adresses OTLP (OpenTelemetry Protocol).
Paramètres internes que .NET.NET Aspire utilise pour exécuter l’hôte de l’application. Ceux-ci sont définis en interne, mais sont accessibles par des intégrations qui étendent .NET.NET Aspire.

La configuration de l’hôte d’application est fournie par le profil de lancement de l’hôte d’application. L’hôte de l’application a un appel de fichier de paramètres de lancement launchSettings.json qui a une liste de profils de lancement. Chaque profil de lancement est une collection d’options associées qui définit la façon dont vous souhaitez dotnet démarrer votre application.

JSON

{
  "$schema": "https://json.schemastore.org/launchsettings.json",
  "profiles": {
    "https": {
      "commandName": "Project",
      "dotnetRunMessages": true,
      "launchBrowser": true,
      "applicationUrl": "https://localhost:17134;http://localhost:15170",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development",
        "DOTNET_ENVIRONMENT": "Development",
        "DOTNET_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:21030",
        "DOTNET_RESOURCE_SERVICE_ENDPOINT_URL": "https://localhost:22057"
      }
    }
  }
}

Fichier de paramètres de lancement précédent :

Possède un profil de lancement nommé https.
Configure un projet hôte d’application .NET.NET Aspire :
- La propriété applicationUrl configure l’adresse de lancement du tableau de bord (ASPNETCORE_URLS).
- Les variables d’environnement telles que DOTNET_DASHBOARD_OTLP_ENDPOINT_URL et DOTNET_RESOURCE_SERVICE_ENDPOINT_URL sont définies sur l’hôte de l’application.

Pour plus d’informations, consultez .NET.NET Aspire et lancer des profils.

Notes

La configuration décrite dans cette page concerne .NET.NET Aspire projet hôte d’application. Pour configurer le tableau de bord autonome, consultez configuration du tableau de bord.

Configuration courante

Option	Valeur par défaut	Description
`ASPIRE_ALLOW_UNSECURED_TRANSPORT`	`false`	Autorise la communication avec l’hôte de l’application sans https. `ASPNETCORE_URLS` (adresse du tableau de bord) et `DOTNET_RESOURCE_SERVICE_ENDPOINT_URL` (adresse du service de ressource hôte d’application) doivent être sécurisés avec HTTPS, sauf vrai.
`DOTNET_ASPIRE_CONTAINER_RUNTIME`	`docker`	Permet à l’utilisateur d’autres runtimes de conteneur pour les ressources sauvegardées par des conteneurs. Les valeurs possibles sont `docker` (par défaut) ou `podman`. Consultez vue d’ensemble de l’installation et des outils pour plus d’informations.

Service de ressources

Un service de ressources est hébergé par l’hôte de l’application. Le service de ressources est utilisé par le tableau de bord pour extraire des informations sur les ressources qui sont orchestrées par .NET.NET Aspire.

Option	Valeur par défaut	Description
`DOTNET_RESOURCE_SERVICE_ENDPOINT_URL`	`null`	Configure l’adresse du service de ressources hébergé par l’hôte de l’application. Généré automatiquement avec launchSettings.json pour avoir un port aléatoire sur localhost. Par exemple, `https://localhost:17037`.
`DOTNET_DASHBOARD_RESOURCESERVICE_APIKEY`	Jeton d’entropie 128 bits généré automatiquement.	Clé API utilisée pour authentifier les demandes adressées au service de ressources de l’hôte d’application. La clé API est requise si l’hôte de l’application est en mode d’exécution, que le tableau de bord n’est pas désactivé et que le tableau de bord n’est pas configuré pour autoriser l’accès anonyme avec `DOTNET_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS`.

Tableau de bord

Par défaut, le tableau de bord est démarré automatiquement par l’hôte de l’application. Le tableau de bord prend en charge son propre ensemble dede configuration, et certains paramètres peuvent être configurés à partir de l’hôte de l’application.

Option	Valeur par défaut	Description
`ASPNETCORE_URLS`	`null`	Adresse du tableau de bord. Doit être `https`, sauf si `ASPIRE_ALLOW_UNSECURED_TRANSPORT` ou `DistributedApplicationOptions.AllowUnsecuredTransport` est vrai. Généré automatiquement avec launchSettings.json pour avoir un port aléatoire sur localhost. La valeur dans les paramètres de lancement est définie sur la propriété `applicationUrls`.
`ASPNETCORE_ENVIRONMENT`	`Production`	Configure l’environnement sous lequel le tableau de bord s’exécute. Pour plus d’informations, consultez Utiliser plusieurs environnements dans ASP.NET Core.
`DOTNET_DASHBOARD_OTLP_ENDPOINT_URL`	`http://localhost:18889` si aucun point de terminaison gRPC n’est configuré.	Configure l’adresse gRPC otLP du tableau de bord. Utilisé par le tableau de bord pour recevoir des données de télémétrie via OTLP. Définissez les ressources en tant que `OTEL_EXPORTER_OTLP_ENDPOINT` var. La `OTEL_EXPORTER_OTLP_PROTOCOL` var est `grpc`. Généré automatiquement avec launchSettings.json pour avoir un port aléatoire sur localhost.
`DOTNET_DASHBOARD_OTLP_HTTP_ENDPOINT_URL`	`null`	Configure l’adresse HTTP OTLP du tableau de bord. Utilisé par le tableau de bord pour recevoir des données de télémétrie via OTLP. Si seule `DOTNET_DASHBOARD_OTLP_HTTP_ENDPOINT_URL` est configurée, elle est définie sur les ressources en tant que `OTEL_EXPORTER_OTLP_ENDPOINT` var. La `OTEL_EXPORTER_OTLP_PROTOCOL` var est `http/protobuf`.
`DOTNET_DASHBOARD_FRONTEND_BROWSERTOKEN`	Jeton d’entropie 128 bits généré automatiquement.	Configure le jeton de navigateur frontal. Il s’agit de la valeur qui doit être entrée pour accéder au tableau de bord lorsque le mode d’authentification est BrowserToken. Si aucun jeton de navigateur n’est spécifié, un nouveau jeton est généré chaque fois que l’hôte de l’application est lancé.

Interne

Les paramètres internes sont utilisés par l’hôte et les intégrations de l’application. Les paramètres internes ne sont pas conçus pour être configurés directement.

Option	Valeur par défaut	Description
`AppHost:Directory`	Racine du contenu s’il n’y a pas de projet.	Répertoire du projet où se trouve l’hôte de l’application. Accessible à partir du IDistributedApplicationBuilder.AppHostDirectory.
`AppHost:Path`	Répertoire combiné au nom de l’application.	Chemin d’accès à l’hôte de l’application. Il combine le répertoire avec le nom de l’application.
`AppHost:Sha256`	Il est créé à partir du nom d’hôte de l’application lorsque l’hôte de l’application est en mode de publication. Sinon, il est créé à partir du chemin d’accès de l’hôte de l’application.	Hachage codé en hexadécimal pour l’application actuelle. Le hachage est basé sur l’emplacement de l’application sur l’ordinateur actuel afin qu’il soit stable entre les lancements de l’hôte de l’application.
`AppHost:OtlpApiKey`	Jeton d’entropie 128 bits généré automatiquement.	Clé API utilisée pour authentifier les demandes envoyées au service OTLP du tableau de bord. La valeur est présente si nécessaire : l’hôte de l’application est en mode d’exécution, le tableau de bord n’est pas désactivé et le tableau de bord n’est pas configuré pour autoriser l’accès anonyme avec `DOTNET_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS`.
`AppHost:BrowserToken`	Jeton d’entropie 128 bits généré automatiquement.	Jeton de navigateur utilisé pour authentifier la navigation dans le tableau de bord lorsqu’il est lancé par l’hôte de l’application. Le jeton de navigateur peut être défini par `DOTNET_DASHBOARD_FRONTEND_BROWSERTOKEN`. La valeur est présente si nécessaire : l’hôte de l’application est en mode d’exécution, le tableau de bord n’est pas désactivé et le tableau de bord n’est pas configuré pour autoriser l’accès anonyme avec `DOTNET_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS`.
`AppHost:ResourceService:AuthMode`	`ApiKey`. Si `DOTNET_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS` a la valeur true, la valeur est `Unsecured`.	Mode d’authentification utilisé pour accéder au service de ressources. La valeur est présente si nécessaire : l’hôte de l’application est en mode d’exécution et le tableau de bord n’est pas désactivé.
`AppHost:ResourceService:ApiKey`	Jeton d’entropie 128 bits généré automatiquement.	Clé API utilisée pour authentifier les demandes adressées au service de ressources de l’hôte d’application. La clé API peut être définie par `DOTNET_DASHBOARD_RESOURCESERVICE_APIKEY`. La valeur est présente si nécessaire : l’hôte de l’application est en mode d’exécution, le tableau de bord n’est pas désactivé et le tableau de bord n’est pas configuré pour autoriser l’accès anonyme avec `DOTNET_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS`.

Partager via