@microsoft/agents-a365-runtime package

Classes

AgenticAuthenticationService

Service de gestion de l’authentification utilisateur agentique.

DefaultConfigurationProvider

Fournisseur par défaut qui retourne la configuration basée sur l’environnement.

Considérations multilocataires : Ce fournisseur crée une instance de configuration unique au moment de la construction, partagée entre toutes les requêtes d’un processus. Les fournisseurs au niveau du module par défaut (par exemple, defaultRuntimeConfigurationProvider) sont des singletons.

Pour les scénarios multilocataires, deux approches sont prises en charge :

  1. Fonctions de remplacement dynamique (recommandées) : Passez les fonctions de remplacement qui lisent à partir du contexte asynchrone (par exemple, les bagages OpenTelemetry) au moment de l’exécution. La même instance de configuration retourne des valeurs différentes par requête.

    const config = new ToolingConfiguration({
      mcpPlatformEndpoint: () => {
        const tenantConfig = context.active().getValue(TENANT_KEY);
        return tenantConfig?.endpoint ?? 'https://default.endpoint';
      }
    });
    
  2. Fournisseurs par locataire : Créez des instances de fournisseur distinctes pour chaque locataire lorsque différents locataires ont besoin de différentes fonctions de remplacement entièrement.

OperationError

Encapsule une erreur à partir d’une opération.

OperationResult

Représente le résultat d’une opération.

PowerPlatformApiDiscovery
RuntimeConfiguration

Classe de configuration de base pour le Kit de développement logiciel (SDK) Agent365. D’autres packages étendent cette option pour ajouter leurs propres paramètres.

Les fonctions de remplacement sont appelées sur chaque accès aux propriétés, ce qui active la résolution dynamique à partir du contexte asynchrone (par exemple, les bagages OpenTelemetry) par requête.

Utility

Classe utilitaire fournissant des méthodes d’assistance pour les opérations d’exécution de l’agent.

Interfaces

IConfigurationProvider

Interface générique pour fournir la configuration. Chaque package définit son propre type de configuration T.

Alias de type

RuntimeConfigurationOptions

Options de configuration du runtime : toutes les fonctions facultatives. Les fonctions sont appelées sur chaque accès aux propriétés, ce qui active la résolution dynamique. Les valeurs non définies sont renvoyées aux variables d’environnement.

Énumérations

ClusterCategory

Catégories de cluster pour la découverte d’API Power Platform. L’énumération de chaînes fournit à la fois la sécurité du type au moment de la compilation et la validation du runtime.

Functions

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)

Obtient la catégorie de cluster à partir des variables d’environnement.

Exemple

// Before:
import { getClusterCategory } from '@microsoft/agents-a365-runtime';
const cluster = getClusterCategory();

// After:
import { defaultRuntimeConfigurationProvider } from '@microsoft/agents-a365-runtime';
const cluster = defaultRuntimeConfigurationProvider.getConfiguration().clusterCategory;
getMcpPlatformAuthenticationScope()

Obtient l’étendue d’authentification de la plateforme MCP.

Exemple

// Before:
import { getMcpPlatformAuthenticationScope } from '@microsoft/agents-a365-runtime';
const scope = getMcpPlatformAuthenticationScope();

// After:
import { defaultToolingConfigurationProvider } from '@microsoft/agents-a365-tooling';
const scope = defaultToolingConfigurationProvider.getConfiguration().mcpPlatformAuthenticationScope;
getObservabilityAuthenticationScope()

Retourne l’étendue de l’authentification auprès du service d’observabilité.

Exemple

// Before:
import { getObservabilityAuthenticationScope } from '@microsoft/agents-a365-runtime';
const scopes = getObservabilityAuthenticationScope();

// After:
import { defaultObservabilityConfigurationProvider } from '@microsoft/agents-a365-observability';
const scopes = [...defaultObservabilityConfigurationProvider.getConfiguration().observabilityAuthenticationScopes];
isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)

Retourne true si l’environnement actuel est un environnement de développement.

Exemple

// Before:
import { isDevelopmentEnvironment } from '@microsoft/agents-a365-runtime';
if (isDevelopmentEnvironment()) { ... }

// After:
import { defaultRuntimeConfigurationProvider } from '@microsoft/agents-a365-runtime';
if (defaultRuntimeConfigurationProvider.getConfiguration().isDevelopmentEnvironment) { ... }

Variables

DEVELOPMENT_ENVIRONMENT_NAME
PRODUCTION_ENVIRONMENT_NAME
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE

Étendue d’authentification de la plateforme MCP de production.

PROD_OBSERVABILITY_CLUSTER_CATEGORY

Catégorie de cluster par défaut pour les environnements de production.

PROD_OBSERVABILITY_SCOPE

Étendue d’authentification de l’observabilité de la production.

defaultRuntimeConfigurationProvider

Fournisseur par défaut partagé pour RuntimeConfiguration. Utilise des variables d’environnement sans remplacements , adaptées aux déploiements à locataire unique ou lors de l’utilisation de fonctions de remplacement dynamique pour l’architecture mutualisée.

Informations relatives à la fonction

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)

Avertissement

Cette API est à présent déconseillée.

Use RuntimeConfiguration.clusterCategory instead.

Obtient la catégorie de cluster à partir des variables d’environnement.

Exemple

// Before:
import { getClusterCategory } from '@microsoft/agents-a365-runtime';
const cluster = getClusterCategory();

// After:
import { defaultRuntimeConfigurationProvider } from '@microsoft/agents-a365-runtime';
const cluster = defaultRuntimeConfigurationProvider.getConfiguration().clusterCategory;
function getClusterCategory(configProvider?: IConfigurationProvider<RuntimeConfiguration>): string

Paramètres

configProvider

IConfigurationProvider<RuntimeConfiguration>

Fournisseur de configuration facultatif. La valeur par défaut est defaultRuntimeConfigurationProvider si elle n’est pas spécifiée.

Retours

string

La catégorie de cluster de CLUSTER_CATEGORY var env est par défaut « prod ».

getMcpPlatformAuthenticationScope()

Avertissement

Cette API est à présent déconseillée.

Use ToolingConfiguration.mcpPlatformAuthenticationScope instead.

Obtient l’étendue d’authentification de la plateforme MCP.

Exemple

// Before:
import { getMcpPlatformAuthenticationScope } from '@microsoft/agents-a365-runtime';
const scope = getMcpPlatformAuthenticationScope();

// After:
import { defaultToolingConfigurationProvider } from '@microsoft/agents-a365-tooling';
const scope = defaultToolingConfigurationProvider.getConfiguration().mcpPlatformAuthenticationScope;
function getMcpPlatformAuthenticationScope(): string

Retours

string

Étendue de l’authentification de la plateforme MCP.

getObservabilityAuthenticationScope()

Avertissement

Cette API est à présent déconseillée.

Use ObservabilityConfiguration.observabilityAuthenticationScopes instead.

Retourne l’étendue de l’authentification auprès du service d’observabilité.

Exemple

// Before:
import { getObservabilityAuthenticationScope } from '@microsoft/agents-a365-runtime';
const scopes = getObservabilityAuthenticationScope();

// After:
import { defaultObservabilityConfigurationProvider } from '@microsoft/agents-a365-observability';
const scopes = [...defaultObservabilityConfigurationProvider.getConfiguration().observabilityAuthenticationScopes];
function getObservabilityAuthenticationScope(): string[]

Retours

string[]

Étendues d’authentification pour l’environnement actuel.

isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)

Avertissement

Cette API est à présent déconseillée.

Use RuntimeConfiguration.isDevelopmentEnvironment instead.

Retourne true si l’environnement actuel est un environnement de développement.

Exemple

// Before:
import { isDevelopmentEnvironment } from '@microsoft/agents-a365-runtime';
if (isDevelopmentEnvironment()) { ... }

// After:
import { defaultRuntimeConfigurationProvider } from '@microsoft/agents-a365-runtime';
if (defaultRuntimeConfigurationProvider.getConfiguration().isDevelopmentEnvironment) { ... }
function isDevelopmentEnvironment(configProvider?: IConfigurationProvider<RuntimeConfiguration>): boolean

Paramètres

configProvider

IConfigurationProvider<RuntimeConfiguration>

Fournisseur de configuration facultatif. La valeur par défaut est defaultRuntimeConfigurationProvider si elle n’est pas spécifiée.

Retours

boolean

True si l’environnement actuel est le développement, false dans le cas contraire.

Détails de variable

DEVELOPMENT_ENVIRONMENT_NAME

DEVELOPMENT_ENVIRONMENT_NAME: "Development"

Type

"Development"

PRODUCTION_ENVIRONMENT_NAME

PRODUCTION_ENVIRONMENT_NAME: "production"

Type

"production"

PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE

Avertissement

Cette API est à présent déconseillée.

This constant is exported for backward compatibility only. For new code, use ToolingConfiguration.mcpPlatformAuthenticationScope instead.

Étendue d’authentification de la plateforme MCP de production.

PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE: "ea9ffc3e-8a23-4a7d-836d-234d7c7565c1/.default"

Type

string

PROD_OBSERVABILITY_CLUSTER_CATEGORY

Avertissement

Cette API est à présent déconseillée.

This constant is exported for backward compatibility only. For new code, use RuntimeConfiguration.clusterCategory instead.

Catégorie de cluster par défaut pour les environnements de production.

PROD_OBSERVABILITY_CLUSTER_CATEGORY: "prod"

Type

"prod"

PROD_OBSERVABILITY_SCOPE

Avertissement

Cette API est à présent déconseillée.

This constant is exported for backward compatibility only. For new code, use ObservabilityConfiguration.observabilityAuthenticationScopes instead.

Étendue d’authentification de l’observabilité de la production.

PROD_OBSERVABILITY_SCOPE: "https://api.powerplatform.com/.default"

Type

string

defaultRuntimeConfigurationProvider

Fournisseur par défaut partagé pour RuntimeConfiguration. Utilise des variables d’environnement sans remplacements , adaptées aux déploiements à locataire unique ou lors de l’utilisation de fonctions de remplacement dynamique pour l’architecture mutualisée.

defaultRuntimeConfigurationProvider: DefaultConfigurationProvider<RuntimeConfiguration>

Type