@microsoft/agents-a365-runtime package

Klasser

AgenticAuthenticationService

Tjeneste til håndtering af agentisk brugergodkendelse.

DefaultConfigurationProvider

Standardprovider, der returnerer miljøbaseret konfiguration.

Overvejelser i forbindelse med flere lejere: Denne provider opretter en enkelt konfigurationsforekomst på byggetidspunktet, der deles på tværs af alle anmodninger i en proces. Standardudbydere på modulniveau (f.eks. defaultRuntimeConfigurationProvider) er singletoner.

I scenarier med flere lejere understøttes to fremgangsmåder:

  1. Dynamiske tilsidesættelsesfunktioner (anbefales): Overfør tilsidesættelsesfunktioner, der læses fra asynkron kontekst (f.eks. OpenTelemetry-bagage) på kørselstidspunktet. Den samme konfigurationsforekomst returnerer forskellige værdier pr. anmodning.

    const config = new ToolingConfiguration({
      mcpPlatformEndpoint: () => {
        const tenantConfig = context.active().getValue(TENANT_KEY);
        return tenantConfig?.endpoint ?? 'https://default.endpoint';
      }
    });
    
  2. Udbydere pr. lejer: Opret separate providerforekomster for hver lejer, når forskellige lejere har brug for helt forskellige tilsidesættelsesfunktioner.

OperationError

Encapsulates en fejl fra en handling.

OperationResult

Repræsenterer resultatet af en handling.

PowerPlatformApiDiscovery
RuntimeConfiguration

Grundlæggende konfigurationsklasse for Agent365 SDK. Andre pakker udvider dette for at tilføje deres egne indstillinger.

Tilsidesættelsesfunktioner kaldes for hver egenskabsadgang, hvilket aktiverer dynamisk opløsning fra asynkron kontekst (f.eks. OpenTelemetry-bagage) pr. anmodning.

Utility

Utility class, der leverer hjælpemetoder til agent runtime-handlinger.

Grænseflader

IConfigurationProvider

Generisk grænseflade til angivelse af konfiguration. Hver pakke definerer sin egen konfigurationstype T.

Typealiasser

RuntimeConfigurationOptions

Konfigurationsindstillinger for kørsel – alle valgfri funktioner. Funktioner kaldes for hver egenskabsadgang og aktiverer dynamisk opløsning. Unset-værdier falder tilbage til miljøvariabler.

Optællinger

ClusterCategory

Klyngekategorier til Registrering af Power Platform-API. Strengoptællingen giver både sikkerhed af kompileringstidstype og validering af kørsel.

Funktioner

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)

Henter klyngekategorien fra miljøvariabler.

Eksempel

// 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()

Henter omfanget af MCP-platformens godkendelse.

Eksempel

// 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()

Returnerer området for godkendelse til tjenesten observability.

Eksempel

// 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>)

Returnerer sand, hvis det aktuelle miljø er et udviklingsmiljø.

Eksempel

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

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

Variabler

DEVELOPMENT_ENVIRONMENT_NAME
PRODUCTION_ENVIRONMENT_NAME
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE

Produktions-MCP-platformgodkendelsesområde.

PROD_OBSERVABILITY_CLUSTER_CATEGORY

Standardklyngekategori for produktionsmiljøer.

PROD_OBSERVABILITY_SCOPE

Godkendelsesområde for godkendelse af produktions observabilitet.

defaultRuntimeConfigurationProvider

Delt standardprovider for RuntimeConfiguration. Bruger miljøvariabler uden tilsidesættelser – egnet til udrulninger med en enkelt lejer, eller når der bruges dynamiske tilsidesættelsesfunktioner til flere lejere.

Oplysninger om funktion

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)

Advarsel!

Denne API udfases nu.

Use RuntimeConfiguration.clusterCategory instead.

Henter klyngekategorien fra miljøvariabler.

Eksempel

// 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

Parametre

configProvider

IConfigurationProvider<RuntimeConfiguration>

Valgfri konfigurationsprovider. StandardenRuntimeConfigurationProvider er som standard, hvis den ikke er angivet.

Returnerer

string

Klyngekategorien fra CLUSTER_CATEGORY env var er som standard "prod".

getMcpPlatformAuthenticationScope()

Advarsel!

Denne API udfases nu.

Use ToolingConfiguration.mcpPlatformAuthenticationScope instead.

Henter omfanget af MCP-platformens godkendelse.

Eksempel

// 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

Returnerer

string

Godkendelsesområdet for MCP-platformen.

getObservabilityAuthenticationScope()

Advarsel!

Denne API udfases nu.

Use ObservabilityConfiguration.observabilityAuthenticationScopes instead.

Returnerer området for godkendelse til tjenesten observability.

Eksempel

// 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[]

Returnerer

string[]

Godkendelsesområder for det aktuelle miljø.

isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)

Advarsel!

Denne API udfases nu.

Use RuntimeConfiguration.isDevelopmentEnvironment instead.

Returnerer sand, hvis det aktuelle miljø er et udviklingsmiljø.

Eksempel

// 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

Parametre

configProvider

IConfigurationProvider<RuntimeConfiguration>

Valgfri konfigurationsprovider. StandardenRuntimeConfigurationProvider er som standard, hvis den ikke er angivet.

Returnerer

boolean

Sand, hvis det aktuelle miljø er udvikling, ellers falsk.

Variabeldetaljer

DEVELOPMENT_ENVIRONMENT_NAME

DEVELOPMENT_ENVIRONMENT_NAME: "Development"

Type

"Development"

PRODUCTION_ENVIRONMENT_NAME

PRODUCTION_ENVIRONMENT_NAME: "production"

Type

"production"

PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE

Advarsel!

Denne API udfases nu.

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

Produktions-MCP-platformgodkendelsesområde.

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

Type

string

PROD_OBSERVABILITY_CLUSTER_CATEGORY

Advarsel!

Denne API udfases nu.

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

Standardklyngekategori for produktionsmiljøer.

PROD_OBSERVABILITY_CLUSTER_CATEGORY: "prod"

Type

"prod"

PROD_OBSERVABILITY_SCOPE

Advarsel!

Denne API udfases nu.

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

Godkendelsesområde for godkendelse af produktions observabilitet.

PROD_OBSERVABILITY_SCOPE: "api://9b975845-388f-4429-889e-eab1ef63949c/.default"

Type

string

defaultRuntimeConfigurationProvider

Delt standardprovider for RuntimeConfiguration. Bruger miljøvariabler uden tilsidesættelser – egnet til udrulninger med en enkelt lejer, eller når der bruges dynamiske tilsidesættelsesfunktioner til flere lejere.

defaultRuntimeConfigurationProvider: DefaultConfigurationProvider<RuntimeConfiguration>

Type