@microsoft/agents-a365-runtime package
Klasy
| AgenticAuthenticationService |
Usługa do obsługi uwierzytelniania użytkownika agenta. |
| DefaultConfigurationProvider |
Domyślny dostawca, który zwraca konfigurację opartą na środowisku.
Zagadnienia dotyczące wielu dzierżaw: Ten dostawca tworzy pojedyncze wystąpienie konfiguracji w czasie budowy, współużytkowane we wszystkich żądaniach w procesie. Domyślni dostawcy na poziomie modułu (np W przypadku scenariuszy obejmujących wiele dzierżaw obsługiwane są dwa podejścia:
|
| OperationError |
Hermetyzuje błąd operacji. |
| OperationResult |
Reprezentuje wynik operacji. |
| PowerPlatformApiDiscovery | |
| RuntimeConfiguration |
Podstawowa klasa konfiguracji dla zestawu SDK Agent365. Inne pakiety rozszerzają tę opcję, aby dodać własne ustawienia. Funkcje zastąpienia są wywoływane dla każdego dostępu do właściwości, co umożliwia dynamiczne rozpoznawanie z kontekstu asynchronicznego (np. bagażu OpenTelemetry) na żądanie. |
| Utility |
Klasa narzędzi zapewniająca metody pomocnicze dla operacji środowiska uruchomieniowego agenta. |
Interfejsy
| IConfigurationProvider |
Interfejs ogólny zapewniający konfigurację. Każdy pakiet definiuje własny typ konfiguracji T. |
Aliasy typu
| RuntimeConfigurationOptions |
Opcje konfiguracji środowiska uruchomieniowego — wszystkie funkcje opcjonalne. Funkcje są wywoływane dla każdego dostępu do właściwości, co umożliwia rozpoznawanie dynamiczne. Nieustawionych wartości wracają do zmiennych środowiskowych. |
Wyliczenia
| ClusterCategory |
Kategorie klastrów na potrzeby odnajdywania interfejsu API platformy Power Platform. Wyliczenie ciągów zapewnia zarówno bezpieczeństwo typu kompilowania, jak i walidację środowiska uruchomieniowego. |
Funkcje
| get |
Pobiera kategorię klastra ze zmiennych środowiskowych. Przykład
|
| get |
Pobiera zakres uwierzytelniania platformy MCP. Przykład
|
| get |
Zwraca zakres uwierzytelniania w usłudze obserwacji. Przykład
|
| is |
Zwraca wartość true, jeśli bieżące środowisko jest środowiskiem projektowym. Przykład
|
Zmienne
| DEVELOPMENT_ENVIRONMENT_NAME | |
| PRODUCTION_ENVIRONMENT_NAME | |
| PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE | Zakres uwierzytelniania platformy MCP w środowisku produkcyjnym. |
| PROD_OBSERVABILITY_CLUSTER_CATEGORY | Domyślna kategoria klastra dla środowisk produkcyjnych. |
| PROD_OBSERVABILITY_SCOPE | Zakres uwierzytelniania możliwości obserwowania w środowisku produkcyjnym. |
| default |
Udostępniony domyślny dostawca środowiska RuntimeConfiguration. Używa zmiennych środowiskowych bez przesłonięć — odpowiednich dla wdrożeń z jedną dzierżawą lub w przypadku używania funkcji zastąpienia dynamicznego dla wielu dzierżaw. |
Szczegóły funkcji
getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)
Ostrzeżenie
Ten interfejs API jest już przestarzały.
Use RuntimeConfiguration.clusterCategory instead.
Pobiera kategorię klastra ze zmiennych środowiskowych.
Przykład
// 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
Parametry
- configProvider
Opcjonalny dostawca konfiguracji. Wartość domyślna ToRuntimeConfigurationProvider, jeśli nie zostanie określona.
Zwraca
string
Kategoria klastra z CLUSTER_CATEGORY env var domyślnie to "prod".
getMcpPlatformAuthenticationScope()
Ostrzeżenie
Ten interfejs API jest już przestarzały.
Use ToolingConfiguration.mcpPlatformAuthenticationScope instead.
Pobiera zakres uwierzytelniania platformy MCP.
Przykład
// 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
Zwraca
string
Zakres uwierzytelniania platformy MCP.
getObservabilityAuthenticationScope()
Ostrzeżenie
Ten interfejs API jest już przestarzały.
Use ObservabilityConfiguration.observabilityAuthenticationScopes instead.
Zwraca zakres uwierzytelniania w usłudze obserwacji.
Przykład
// 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[]
Zwraca
string[]
Zakresy uwierzytelniania dla bieżącego środowiska.
isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)
Ostrzeżenie
Ten interfejs API jest już przestarzały.
Use RuntimeConfiguration.isDevelopmentEnvironment instead.
Zwraca wartość true, jeśli bieżące środowisko jest środowiskiem projektowym.
Przykład
// 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
Parametry
- configProvider
Opcjonalny dostawca konfiguracji. Wartość domyślna ToRuntimeConfigurationProvider, jeśli nie zostanie określona.
Zwraca
boolean
Wartość True, jeśli bieżące środowisko jest opracowywane, w przeciwnym razie wartość false.
Szczegóły zmiennej
DEVELOPMENT_ENVIRONMENT_NAME
DEVELOPMENT_ENVIRONMENT_NAME: "Development"
Typ
"Development"
PRODUCTION_ENVIRONMENT_NAME
PRODUCTION_ENVIRONMENT_NAME: "production"
Typ
"production"
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE
Ostrzeżenie
Ten interfejs API jest już przestarzały.
This constant is exported for backward compatibility only.
For new code, use ToolingConfiguration.mcpPlatformAuthenticationScope instead.
Zakres uwierzytelniania platformy MCP w środowisku produkcyjnym.
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE: "ea9ffc3e-8a23-4a7d-836d-234d7c7565c1/.default"
Typ
string
PROD_OBSERVABILITY_CLUSTER_CATEGORY
Ostrzeżenie
Ten interfejs API jest już przestarzały.
This constant is exported for backward compatibility only.
For new code, use RuntimeConfiguration.clusterCategory instead.
Domyślna kategoria klastra dla środowisk produkcyjnych.
PROD_OBSERVABILITY_CLUSTER_CATEGORY: "prod"
Typ
"prod"
PROD_OBSERVABILITY_SCOPE
Ostrzeżenie
Ten interfejs API jest już przestarzały.
This constant is exported for backward compatibility only.
For new code, use ObservabilityConfiguration.observabilityAuthenticationScopes instead.
Zakres uwierzytelniania możliwości obserwowania w środowisku produkcyjnym.
PROD_OBSERVABILITY_SCOPE: "api://9b975845-388f-4429-889e-eab1ef63949c/.default"
Typ
string
defaultRuntimeConfigurationProvider
Udostępniony domyślny dostawca środowiska RuntimeConfiguration. Używa zmiennych środowiskowych bez przesłonięć — odpowiednich dla wdrożeń z jedną dzierżawą lub w przypadku używania funkcji zastąpienia dynamicznego dla wielu dzierżaw.
defaultRuntimeConfigurationProvider: DefaultConfigurationProvider<RuntimeConfiguration>