@microsoft/agents-a365-runtime package

クラス

AgenticAuthenticationService

エージェント ユーザー認証を処理するためのサービス。

DefaultConfigurationProvider

環境ベースの構成を返す既定のプロバイダー。

マルチテナントに関する考慮事項: このプロバイダーは、構築時に 1 つの構成インスタンスを作成し、プロセス内のすべての要求で共有します。 既定のモジュール レベルのプロバイダー (例: defaultRuntimeConfigurationProvider) はシングルトンです。

マルチテナント シナリオでは、次の 2 つの方法がサポートされています。

  1. 動的オーバーライド関数 (推奨): 実行時に非同期コンテキスト (OpenTelemetry 手荷物など) から読み取るオーバーライド関数を渡します。 同じ構成インスタンスは、要求ごとに異なる値を返します。

    const config = new ToolingConfiguration({
      mcpPlatformEndpoint: () => {
        const tenantConfig = context.active().getValue(TENANT_KEY);
        return tenantConfig?.endpoint ?? 'https://default.endpoint';
      }
    });
    
  2. テナントごとのプロバイダー: 異なるテナントで異なるオーバーライド関数が完全に必要な場合は、テナントごとに個別のプロバイダー インスタンスを作成します。

OperationError

操作からのエラーをカプセル化します。

OperationResult

操作の結果を表します。

PowerPlatformApiDiscovery
RuntimeConfiguration

Agent365 SDK の基本構成クラス。 他のパッケージでは、独自の設定を追加するためにこれを拡張します。

オーバーライド関数は、各プロパティ アクセスで呼び出され、要求ごとの非同期コンテキスト (OpenTelemetry 手荷物など) からの動的解決が可能になります。

Utility

エージェントのランタイム操作用のヘルパー メソッドを提供するユーティリティ クラス。

インターフェイス

IConfigurationProvider

構成を提供するための汎用インターフェイス。 各パッケージは、独自の構成の種類 T を定義します。

型エイリアス

RuntimeConfigurationOptions

ランタイム構成オプション - すべての省略可能な関数。 各プロパティ アクセスで関数が呼び出され、動的解決が可能になります。 未設定の値は環境変数にフォールバックします。

列挙型

ClusterCategory

Power Platform API 検出のクラスター カテゴリ。 文字列列挙型は、コンパイル時の型の安全性とランタイム検証の両方を提供します。

関数

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)

環境変数からクラスター カテゴリを取得します。

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

MCP プラットフォーム認証スコープを取得します。

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

監視サービスに対する認証のスコープを返します。

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

現在の環境が開発環境の場合は true を返します。

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

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

変数

DEVELOPMENT_ENVIRONMENT_NAME
PRODUCTION_ENVIRONMENT_NAME
PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE

運用 MCP プラットフォームの認証スコープ。

PROD_OBSERVABILITY_CLUSTER_CATEGORY

運用環境の既定のクラスター カテゴリ。

PROD_OBSERVABILITY_SCOPE

運用環境の監視の認証スコープ。

defaultRuntimeConfigurationProvider

RuntimeConfiguration の共有の既定のプロバイダー。 オーバーライドのない環境変数を使用します。シングルテナントデプロイに適しているか、マルチテナントの動的オーバーライド関数を使用する場合に適しています。

関数の詳細

getClusterCategory(IConfigurationProvider<RuntimeConfiguration>)

警告

この API は非推奨になりました。

Use RuntimeConfiguration.clusterCategory instead.

環境変数からクラスター カテゴリを取得します。

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

パラメーター

configProvider

IConfigurationProvider<RuntimeConfiguration>

オプションの構成プロバイダー。 指定しない場合、既定値は defaultRuntimeConfigurationProvider になります。

返品

string

CLUSTER_CATEGORY env var のクラスター カテゴリ。既定値は "prod" です。

getMcpPlatformAuthenticationScope()

警告

この API は非推奨になりました。

Use ToolingConfiguration.mcpPlatformAuthenticationScope instead.

MCP プラットフォーム認証スコープを取得します。

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

返品

string

MCP プラットフォーム認証スコープ。

getObservabilityAuthenticationScope()

警告

この API は非推奨になりました。

Use ObservabilityConfiguration.observabilityAuthenticationScopes instead.

監視サービスに対する認証のスコープを返します。

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

返品

string[]

現在の環境の認証スコープ。

isDevelopmentEnvironment(IConfigurationProvider<RuntimeConfiguration>)

警告

この API は非推奨になりました。

Use RuntimeConfiguration.isDevelopmentEnvironment instead.

現在の環境が開発環境の場合は true を返します。

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

パラメーター

configProvider

IConfigurationProvider<RuntimeConfiguration>

オプションの構成プロバイダー。 指定しない場合、既定値は defaultRuntimeConfigurationProvider になります。

返品

boolean

現在の環境が開発環境の場合は true、それ以外の場合は false。

変数の詳細

DEVELOPMENT_ENVIRONMENT_NAME

DEVELOPMENT_ENVIRONMENT_NAME: "Development"

"Development"

PRODUCTION_ENVIRONMENT_NAME

PRODUCTION_ENVIRONMENT_NAME: "production"

"production"

PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE

警告

この API は非推奨になりました。

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

運用 MCP プラットフォームの認証スコープ。

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

string

PROD_OBSERVABILITY_CLUSTER_CATEGORY

警告

この API は非推奨になりました。

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

運用環境の既定のクラスター カテゴリ。

PROD_OBSERVABILITY_CLUSTER_CATEGORY: "prod"

"prod"

PROD_OBSERVABILITY_SCOPE

警告

この API は非推奨になりました。

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

運用環境の監視の認証スコープ。

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

string

defaultRuntimeConfigurationProvider

RuntimeConfiguration の共有の既定のプロバイダー。 オーバーライドのない環境変数を使用します。シングルテナントデプロイに適しているか、マルチテナントの動的オーバーライド関数を使用する場合に適しています。

defaultRuntimeConfigurationProvider: DefaultConfigurationProvider<RuntimeConfiguration>