@microsoft/agents-a365-runtime package
Classi
| AgenticAuthenticationService |
Servizio per la gestione dell'autenticazione utente agente. |
| DefaultConfigurationProvider |
Provider predefinito che restituisce la configurazione basata sull'ambiente.
Considerazioni su più tenant: Questo provider crea una singola istanza di configurazione in fase di costruzione, condivisa tra tutte le richieste in un processo. I provider predefiniti a livello di modulo ,ad esempio , Per gli scenari multi-tenant, sono supportati due approcci:
|
| OperationError |
Incapsula un errore da un'operazione. |
| OperationResult |
Rappresenta il risultato di un'operazione. |
| PowerPlatformApiDiscovery | |
| RuntimeConfiguration |
Classe di configurazione di base per Agent365 SDK. Altri pacchetti estendono questa opzione per aggiungere le proprie impostazioni. Le funzioni di override vengono chiamate per ogni accesso alle proprietà, abilitando la risoluzione dinamica dal contesto asincrono (ad esempio, bagaglio OpenTelemetry) per ogni richiesta. |
| Utility |
Classe di utilità che fornisce metodi helper per le operazioni di runtime dell'agente. |
Interfacce
| IConfigurationProvider |
Interfaccia generica per fornire la configurazione. Ogni pacchetto definisce il proprio tipo di configurazione T. |
Alias tipo
| RuntimeConfigurationOptions |
Opzioni di configurazione del runtime: tutte le funzioni facoltative. Le funzioni vengono chiamate per ogni accesso alle proprietà, abilitando la risoluzione dinamica. I valori unset rientrano nelle variabili di ambiente. |
Enumerazioni
| ClusterCategory |
Categorie di cluster per l'individuazione dell'API Power Platform. L'enumerazione stringa fornisce sia la sicurezza dei tipi in fase di compilazione che la convalida del runtime. |
Funzioni
| get |
Ottiene la categoria di cluster dalle variabili di ambiente. Esempio
|
| get |
Ottiene l'ambito di autenticazione della piattaforma MCP. Esempio
|
| get |
Restituisce l'ambito per l'autenticazione al servizio di osservabilità. Esempio
|
| is |
Restituisce true se l'ambiente corrente è un ambiente di sviluppo. Esempio
|
Variabili
| DEVELOPMENT_ENVIRONMENT_NAME | |
| PRODUCTION_ENVIRONMENT_NAME | |
| PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE | Ambito di autenticazione della piattaforma MCP di produzione. |
| PROD_OBSERVABILITY_CLUSTER_CATEGORY | Categoria di cluster predefinita per gli ambienti di produzione. |
| PROD_OBSERVABILITY_SCOPE | Ambito di autenticazione dell'osservabilità di produzione. |
| default |
Provider predefinito condiviso per RuntimeConfiguration. Usa variabili di ambiente senza override, adatto per le distribuzioni a tenant singolo o quando si usano funzioni di override dinamiche per multi-tenancy. |
Dettagli funzione
getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)
Avviso
Questa API è ora deprecata.
Use RuntimeConfiguration.clusterCategory instead.
Ottiene la categoria di cluster dalle variabili di ambiente.
Esempio
// 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
Parametri
- configProvider
Provider di configurazione facoltativo. Il valore predefinito è defaultRuntimeConfigurationProvider, se non specificato.
Valori restituiti
string
La categoria di cluster da CLUSTER_CATEGORY env var, per impostazione predefinita è "prod".
getMcpPlatformAuthenticationScope()
Avviso
Questa API è ora deprecata.
Use ToolingConfiguration.mcpPlatformAuthenticationScope instead.
Ottiene l'ambito di autenticazione della piattaforma MCP.
Esempio
// 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
Valori restituiti
string
Ambito di autenticazione della piattaforma MCP.
getObservabilityAuthenticationScope()
Avviso
Questa API è ora deprecata.
Use ObservabilityConfiguration.observabilityAuthenticationScopes instead.
Restituisce l'ambito per l'autenticazione al servizio di osservabilità.
Esempio
// 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[]
Valori restituiti
string[]
Ambiti di autenticazione per l'ambiente corrente.
isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)
Avviso
Questa API è ora deprecata.
Use RuntimeConfiguration.isDevelopmentEnvironment instead.
Restituisce true se l'ambiente corrente è un ambiente di sviluppo.
Esempio
// 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
Parametri
- configProvider
Provider di configurazione facoltativo. Il valore predefinito è defaultRuntimeConfigurationProvider, se non specificato.
Valori restituiti
boolean
True se l'ambiente corrente è in fase di sviluppo, false in caso contrario.
Dettagli delle variabili
DEVELOPMENT_ENVIRONMENT_NAME
DEVELOPMENT_ENVIRONMENT_NAME: "Development"
Tipo
"Development"
PRODUCTION_ENVIRONMENT_NAME
PRODUCTION_ENVIRONMENT_NAME: "production"
Tipo
"production"
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE
Avviso
Questa API è ora deprecata.
This constant is exported for backward compatibility only.
For new code, use ToolingConfiguration.mcpPlatformAuthenticationScope instead.
Ambito di autenticazione della piattaforma MCP di produzione.
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE: "ea9ffc3e-8a23-4a7d-836d-234d7c7565c1/.default"
Tipo
string
PROD_OBSERVABILITY_CLUSTER_CATEGORY
Avviso
Questa API è ora deprecata.
This constant is exported for backward compatibility only.
For new code, use RuntimeConfiguration.clusterCategory instead.
Categoria di cluster predefinita per gli ambienti di produzione.
PROD_OBSERVABILITY_CLUSTER_CATEGORY: "prod"
Tipo
"prod"
PROD_OBSERVABILITY_SCOPE
Avviso
Questa API è ora deprecata.
This constant is exported for backward compatibility only.
For new code, use ObservabilityConfiguration.observabilityAuthenticationScopes instead.
Ambito di autenticazione dell'osservabilità di produzione.
PROD_OBSERVABILITY_SCOPE: "https://api.powerplatform.com/.default"
Tipo
string
defaultRuntimeConfigurationProvider
Provider predefinito condiviso per RuntimeConfiguration. Usa variabili di ambiente senza override, adatto per le distribuzioni a tenant singolo o quando si usano funzioni di override dinamiche per multi-tenancy.
defaultRuntimeConfigurationProvider: DefaultConfigurationProvider<RuntimeConfiguration>