@microsoft/agents-a365-runtime package

Classes

AgenticAuthenticationService	Serviço para lidar com a autenticação de usuário agente.
DefaultConfigurationProvider	Provedor padrão que retorna a configuração baseada em ambiente. Considerações de vários locatários: Esse provedor cria uma única instância de configuração em tempo de construção, compartilhada em todas as solicitações em um processo. Os provedores de nível de módulo padrão (por exemplo, defaultRuntimeConfigurationProvider) são singletons. Para cenários multilocatários, há suporte para duas abordagens: Funções de substituição dinâmica (recomendado): Passe funções de substituição que leem do contexto assíncrono (por exemplo, bagagem OpenTelemetry) em runtime. A mesma instância de configuração retorna valores diferentes por solicitação. const config = new ToolingConfiguration({ mcpPlatformEndpoint: () => { const tenantConfig = context.active().getValue(TENANT_KEY); return tenantConfig?.endpoint ?? 'https://default.endpoint'; } }); Provedores por locatário: Crie instâncias de provedor separadas para cada locatário quando locatários diferentes precisarem de diferentes funções de substituição inteiramente.
OperationError	Encapsula um erro de uma operação.
OperationResult	Representa o resultado de uma operação.
PowerPlatformApiDiscovery
RuntimeConfiguration	Classe de configuração base para o SDK do Agent365. Outros pacotes estendem isso para adicionar suas próprias configurações. As funções de substituição são chamadas em cada acesso à propriedade, permitindo a resolução dinâmica do contexto assíncrono (por exemplo, bagagem OpenTelemetry) por solicitação.
Utility	Classe de utilitário que fornece métodos auxiliares para operações de runtime do agente.

Interfaces

IConfigurationProvider

Interface genérica para fornecer configuração. Cada pacote define seu próprio tipo de configuração T.

Aliases de tipo

RuntimeConfigurationOptions

Opções de configuração de runtime – todas as funções opcionais. As funções são chamadas em cada acesso à propriedade, habilitando a resolução dinâmica. Os valores não definidos retornam às variáveis de ambiente.

Enumerações

ClusterCategory

Categorias de cluster para descoberta de API do Power Platform. A enumeração de cadeia de caracteres fornece segurança de tipo de tempo de compilação e validação de runtime.

Funções

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)	Obtém a categoria de cluster de variáveis de ambiente. Exemplo // 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()	Obtém o escopo de autenticação da plataforma MCP. Exemplo // 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()	Retorna o escopo para autenticação no serviço de observabilidade. Exemplo // 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>)	Retornará true se o ambiente atual for um ambiente de desenvolvimento. Exemplo // Before: import { isDevelopmentEnvironment } from '@microsoft/agents-a365-runtime'; if (isDevelopmentEnvironment()) { ... } // After: import { defaultRuntimeConfigurationProvider } from '@microsoft/agents-a365-runtime'; if (defaultRuntimeConfigurationProvider.getConfiguration().isDevelopmentEnvironment) { ... }

Variáveis

DEVELOPMENT_ENVIRONMENT_NAME
PRODUCTION_ENVIRONMENT_NAME
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE	Escopo de autenticação da plataforma MCP de produção.
PROD_OBSERVABILITY_CLUSTER_CATEGORY	Categoria de cluster padrão para ambientes de produção.
PROD_OBSERVABILITY_SCOPE	Escopo de autenticação de observabilidade de produção.
defaultRuntimeConfigurationProvider	Provedor padrão compartilhado para RuntimeConfiguration. Usa variáveis de ambiente sem substituições , adequadas para implantações de locatário único ou ao usar funções de substituição dinâmica para vários locatários.

Detalhes da função

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)

Aviso

Essa API foi preterida.

Use RuntimeConfiguration.clusterCategory instead.

Obtém a categoria de cluster de variáveis de ambiente.

Exemplo

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

Parâmetros

configProvider

IConfigurationProvider<RuntimeConfiguration>

Provedor de configuração opcional. O padrão será DefaultRuntimeConfigurationProvider se não for especificado.

Retornos

string

A categoria de cluster de CLUSTER_CATEGORY env var, usa como padrão 'prod'.

getMcpPlatformAuthenticationScope()

Aviso

Essa API foi preterida.

Use ToolingConfiguration.mcpPlatformAuthenticationScope instead.

Obtém o escopo de autenticação da plataforma MCP.

Exemplo

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

Retornos

string

O escopo de autenticação da plataforma MCP.

getObservabilityAuthenticationScope()

Aviso

Essa API foi preterida.

Use ObservabilityConfiguration.observabilityAuthenticationScopes instead.

Retorna o escopo para autenticação no serviço de observabilidade.

Exemplo

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

Retornos

string[]

Os escopos de autenticação para o ambiente atual.

isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)

Aviso

Essa API foi preterida.

Use RuntimeConfiguration.isDevelopmentEnvironment instead.

Retornará true se o ambiente atual for um ambiente de desenvolvimento.

Exemplo

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

Parâmetros

configProvider

IConfigurationProvider<RuntimeConfiguration>

Provedor de configuração opcional. O padrão será DefaultRuntimeConfigurationProvider se não for especificado.

Retornos

boolean

True se o ambiente atual for desenvolvimento, false caso contrário.

Detalhes da variável

DEVELOPMENT_ENVIRONMENT_NAME

DEVELOPMENT_ENVIRONMENT_NAME: "Development"

Tipo

"Development"

PRODUCTION_ENVIRONMENT_NAME

PRODUCTION_ENVIRONMENT_NAME: "production"

Tipo

"production"

PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE

Aviso

Essa API foi preterida.

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

Escopo de autenticação da plataforma MCP de produção.

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

Tipo

string

PROD_OBSERVABILITY_CLUSTER_CATEGORY

Aviso

Essa API foi preterida.

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

Categoria de cluster padrão para ambientes de produção.

PROD_OBSERVABILITY_CLUSTER_CATEGORY: "prod"

Tipo

"prod"

PROD_OBSERVABILITY_SCOPE

Aviso

Essa API foi preterida.

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

Escopo de autenticação de observabilidade de produção.

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

Tipo

string

defaultRuntimeConfigurationProvider

Provedor padrão compartilhado para RuntimeConfiguration. Usa variáveis de ambiente sem substituições , adequadas para implantações de locatário único ou ao usar funções de substituição dinâmica para vários locatários.

defaultRuntimeConfigurationProvider: DefaultConfigurationProvider<RuntimeConfiguration>

Tipo

DefaultConfigurationProvider<RuntimeConfiguration>