@microsoft/agents-a365-runtime package
Classes
| AgenticAuthenticationService |
Serviço para gerir autenticação agente de utilizadores. |
| DefaultConfigurationProvider |
Fornecedor predefinido que devolve configuração baseada no ambiente.
Considerações para múltiplos inquilinos: Este fornecedor cria uma única instância de configuração no momento da construção, partilhada entre todos os pedidos de um processo. Os fornecedores padrão ao nível do módulo (por exemplo, Para cenários multi-inquilino, são suportadas duas abordagens:
|
| OperationError |
Encapsula um erro de uma operação. |
| OperationResult |
Representa o resultado de uma operação. |
| PowerPlatformApiDiscovery | |
| RuntimeConfiguration |
Classe base de configuração para o SDK Agent365. Outros pacotes estendem isto para adicionar as suas próprias definições. Funções de sobreposição são chamadas em cada acesso à propriedade, permitindo resolução dinâmica a partir de contexto assíncrono (por exemplo, bagagem OpenTelemetry) por pedido. |
| Utility |
Classe utilitária que fornece métodos auxiliares para operações em tempo de execução do agente. |
Interfaces
| IConfigurationProvider |
Interface genérica para fornecer configuração. Cada pacote define o seu próprio tipo de configuração T. |
Aliases de Tipo
| RuntimeConfigurationOptions |
Opções de configuração em tempo de execução - todas funções opcionais. Funções são chamadas em cada acesso à propriedade, permitindo resolução dinâmica. Valores não definidos voltam a variáveis de ambiente. |
Enumerações
| ClusterCategory |
Categorias de cluster para descoberta de APIs no Power Platform. O enum de string fornece tanto segurança de tipos em tempo de compilação como validação em tempo de execução. |
Funções
| get |
Obtém a categoria cluster a partir das variáveis de ambiente. Exemplo
|
| get |
Recebe o âmbito de autenticação da plataforma MCP. Exemplo
|
| get |
Devolve o âmbito para autenticação ao serviço de observabilidade. Exemplo
|
| is |
Retornos verdadeiros se o ambiente atual for um ambiente de desenvolvimento. Exemplo
|
Variáveis
| DEVELOPMENT_ENVIRONMENT_NAME | |
| PRODUCTION_ENVIRONMENT_NAME | |
| PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE | Âmbito de autenticação da plataforma MCP de produção. |
| PROD_OBSERVABILITY_CLUSTER_CATEGORY | Categoria padrão de cluster para ambientes de produção. |
| PROD_OBSERVABILITY_SCOPE | Âmbito de autenticação de observabilidade em produção. |
| default |
Fornecedor partilhado por defeito para o RuntimeConfiguration. Utiliza variáveis de ambiente sem overrides - adequado para implementações single-tenant ou quando utilizam funções de override dinâmico para multi-tenancy. |
Detalhes de Função
getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)
Aviso
Esta API foi preterida.
Use RuntimeConfiguration.clusterCategory instead.
Obtém a categoria cluster a partir das 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
Fornecedor de configuração opcional. Por defeito é defaultRuntimeConfigurationProvider se não especificado.
Devoluções
string
A categoria cluster de CLUSTER_CATEGORY var ambiental, por defeito é 'prod'.
getMcpPlatformAuthenticationScope()
Aviso
Esta API foi preterida.
Use ToolingConfiguration.mcpPlatformAuthenticationScope instead.
Recebe o âmbito 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
Devoluções
string
O âmbito de autenticação da plataforma MCP.
getObservabilityAuthenticationScope()
Aviso
Esta API foi preterida.
Use ObservabilityConfiguration.observabilityAuthenticationScopes instead.
Devolve o âmbito para autenticação ao 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[]
Devoluções
string[]
A autenticação abrange para o ambiente atual.
isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)
Aviso
Esta API foi preterida.
Use RuntimeConfiguration.isDevelopmentEnvironment instead.
Retornos verdadeiros 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
Fornecedor de configuração opcional. Por defeito é defaultRuntimeConfigurationProvider se não especificado.
Devoluções
boolean
Verdade se o ambiente atual for desenvolvimento, falso caso contrário.
Detalhes das variáveis
DEVELOPMENT_ENVIRONMENT_NAME
DEVELOPMENT_ENVIRONMENT_NAME: "Development"
Tipo
"Development"
PRODUCTION_ENVIRONMENT_NAME
PRODUCTION_ENVIRONMENT_NAME: "production"
Tipo
"production"
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE
Aviso
Esta API foi preterida.
This constant is exported for backward compatibility only.
For new code, use ToolingConfiguration.mcpPlatformAuthenticationScope instead.
Âmbito 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
Esta API foi preterida.
This constant is exported for backward compatibility only.
For new code, use RuntimeConfiguration.clusterCategory instead.
Categoria padrão de cluster para ambientes de produção.
PROD_OBSERVABILITY_CLUSTER_CATEGORY: "prod"
Tipo
"prod"
PROD_OBSERVABILITY_SCOPE
Aviso
Esta API foi preterida.
This constant is exported for backward compatibility only.
For new code, use ObservabilityConfiguration.observabilityAuthenticationScopes instead.
Âmbito de autenticação de observabilidade em produção.
PROD_OBSERVABILITY_SCOPE: "api://9b975845-388f-4429-889e-eab1ef63949c/.default"
Tipo
string
defaultRuntimeConfigurationProvider
Fornecedor partilhado por defeito para o RuntimeConfiguration. Utiliza variáveis de ambiente sem overrides - adequado para implementações single-tenant ou quando utilizam funções de override dinâmico para multi-tenancy.
defaultRuntimeConfigurationProvider: DefaultConfigurationProvider<RuntimeConfiguration>