@microsoft/agents-a365-runtime package
Klasser
| AgenticAuthenticationService |
Tjänst för hantering av agentisk användarautentisering. |
| DefaultConfigurationProvider |
Standardprovider som returnerar miljöbaserad konfiguration.
Överväganden för flera klientorganisationer: Den här providern skapar en enda konfigurationsinstans vid byggtiden, som delas mellan alla begäranden i en process. Standardprovidrar på modulnivå (t.ex. För scenarier med flera klientorganisationer stöds två metoder:
|
| OperationError |
Kapslar in ett fel från en åtgärd. |
| OperationResult |
Representerar resultatet av en åtgärd. |
| PowerPlatformApiDiscovery | |
| RuntimeConfiguration |
Baskonfigurationsklass för Agent365 SDK. Andra paket utökar detta för att lägga till egna inställningar. Åsidosättningsfunktioner anropas för varje egenskapsåtkomst, vilket möjliggör dynamisk upplösning från asynkron kontext (t.ex. OpenTelemetry-bagage) per begäran. |
| Utility |
Verktygsklass som tillhandahåller hjälpmetoder för agentkörningsåtgärder. |
Gränssnitt
| IConfigurationProvider |
Allmänt gränssnitt för att tillhandahålla konfiguration. Varje paket definierar sin egen konfigurationstyp T. |
Typalias
| RuntimeConfigurationOptions |
Körningskonfigurationsalternativ – alla valfria funktioner. Funktioner anropas för varje egenskapsåtkomst, vilket möjliggör dynamisk upplösning. Ta bort värden återgår till miljövariabler. |
Uppräkningar
| ClusterCategory |
Klusterkategorier för identifiering av Power Platform API. Stränguppräkning ger både säkerhet av kompileringstyp och körningsverifiering. |
Funktioner
| get |
Hämtar klusterkategorin från miljövariabler. Example
|
| get |
Hämtar autentiseringsomfånget för MCP-plattformen. Example
|
| get |
Returnerar omfånget för autentisering till observerbarhetstjänsten. Example
|
| is |
Returnerar sant om den aktuella miljön är en utvecklingsmiljö. Example
|
Variabler
| DEVELOPMENT_ENVIRONMENT_NAME | |
| PRODUCTION_ENVIRONMENT_NAME | |
| PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE | Omfång för MCP-plattformsautentisering för produktion. |
| PROD_OBSERVABILITY_CLUSTER_CATEGORY | Standardklusterkategori för produktionsmiljöer. |
| PROD_OBSERVABILITY_SCOPE | Omfång för produktionsobservabilitetsautentisering. |
| default |
Delad standardprovider för RuntimeConfiguration. Använder miljövariabler utan åsidosättningar – lämpliga för distributioner med en klientorganisation eller när du använder dynamiska åsidosättningsfunktioner för flera klientorganisationer. |
Funktionsinformation
getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)
Varning
Det här API:et är nu inaktuellt.
Use RuntimeConfiguration.clusterCategory instead.
Hämtar klusterkategorin från miljövariabler.
Example
// 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
Parametrar
- configProvider
Valfri konfigurationsprovider. Standardvärdet är defaultRuntimeConfigurationProvider om det inte anges.
Returer
string
Klusterkategorin från CLUSTER_CATEGORY env var, är standardvärdet "prod".
getMcpPlatformAuthenticationScope()
Varning
Det här API:et är nu inaktuellt.
Use ToolingConfiguration.mcpPlatformAuthenticationScope instead.
Hämtar autentiseringsomfånget för MCP-plattformen.
Example
// 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
Returer
string
Autentiseringsomfånget för MCP-plattformen.
getObservabilityAuthenticationScope()
Varning
Det här API:et är nu inaktuellt.
Use ObservabilityConfiguration.observabilityAuthenticationScopes instead.
Returnerar omfånget för autentisering till observerbarhetstjänsten.
Example
// 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[]
Returer
string[]
Autentiseringsomfången för den aktuella miljön.
isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)
Varning
Det här API:et är nu inaktuellt.
Use RuntimeConfiguration.isDevelopmentEnvironment instead.
Returnerar sant om den aktuella miljön är en utvecklingsmiljö.
Example
// 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
Parametrar
- configProvider
Valfri konfigurationsprovider. Standardvärdet är defaultRuntimeConfigurationProvider om det inte anges.
Returer
boolean
Sant om den aktuella miljön är utveckling, annars falskt.
Variabelinformation
DEVELOPMENT_ENVIRONMENT_NAME
DEVELOPMENT_ENVIRONMENT_NAME: "Development"
Typ
"Development"
PRODUCTION_ENVIRONMENT_NAME
PRODUCTION_ENVIRONMENT_NAME: "production"
Typ
"production"
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE
Varning
Det här API:et är nu inaktuellt.
This constant is exported for backward compatibility only.
For new code, use ToolingConfiguration.mcpPlatformAuthenticationScope instead.
Omfång för MCP-plattformsautentisering för produktion.
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE: "ea9ffc3e-8a23-4a7d-836d-234d7c7565c1/.default"
Typ
string
PROD_OBSERVABILITY_CLUSTER_CATEGORY
Varning
Det här API:et är nu inaktuellt.
This constant is exported for backward compatibility only.
For new code, use RuntimeConfiguration.clusterCategory instead.
Standardklusterkategori för produktionsmiljöer.
PROD_OBSERVABILITY_CLUSTER_CATEGORY: "prod"
Typ
"prod"
PROD_OBSERVABILITY_SCOPE
Varning
Det här API:et är nu inaktuellt.
This constant is exported for backward compatibility only.
For new code, use ObservabilityConfiguration.observabilityAuthenticationScopes instead.
Omfång för produktionsobservabilitetsautentisering.
PROD_OBSERVABILITY_SCOPE: "api://9b975845-388f-4429-889e-eab1ef63949c/.default"
Typ
string
defaultRuntimeConfigurationProvider
Delad standardprovider för RuntimeConfiguration. Använder miljövariabler utan åsidosättningar – lämpliga för distributioner med en klientorganisation eller när du använder dynamiska åsidosättningsfunktioner för flera klientorganisationer.
defaultRuntimeConfigurationProvider: DefaultConfigurationProvider<RuntimeConfiguration>