@azure/arm-search package
インターフェイス
| AccessRule |
ネットワーク セキュリティ境界構成プロファイルのアクセス規則 |
| AccessRuleProperties |
アクセス規則のプロパティ |
| AccessRulePropertiesSubscriptionsItem |
ネットワークセキュリティ境界の設定 |
| AdminKeyResult |
特定の Azure AI 検索 サービスのプライマリおよびセカンダリ管理者 API キーを含む応答。 |
| AdminKeysGetOptionalParams |
省略可能なパラメーター。 |
| AdminKeysOperations |
AdminKeys操作を表すインターフェース。 |
| AdminKeysRegenerateOptionalParams |
省略可能なパラメーター。 |
| CheckNameAvailabilityInput |
チェック名可用性 API の入力。 |
| CheckNameAvailabilityOutput |
チェック名可用性 API の出力。 |
| CloudError |
API エラーに関する情報が含まれています。 |
| CloudErrorBody |
エラー コードとメッセージを含む特定の API エラーについて説明します。 |
| DataPlaneAadOrApiKeyAuthOption |
認証には、API キーまたは Microsoft Entra ID テナントからのアクセス トークンを使用できることを示します。 |
| DataPlaneAuthOptions |
検索サービスがデータ プレーン要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。 |
| EncryptionWithCmk |
カスタマー マネージド キーを使用して検索サービス内のリソースを暗号化する方法を決定するポリシーについて説明します。 |
| Identity |
検索サービス ID の詳細。 null 値は、検索サービスに ID が割り当てられていないことを示します。 |
| IpRule |
Azure AI 検索 サービスの IP 制限規則。 |
| NetworkRuleSet |
Azure AI 検索 サービスに到達する方法を決定するネットワーク固有のルール。 |
| NetworkSecurityPerimeter |
ネットワーク セキュリティ境界 (NSP) に関する情報 |
| NetworkSecurityPerimeterConfiguration |
ネットワーク セキュリティ境界 (NSP) 構成リソース |
| NetworkSecurityPerimeterConfigurationProperties |
ネットワーク セキュリティ構成プロパティ。 |
| NetworkSecurityPerimeterConfigurationsGetOptionalParams |
省略可能なパラメーター。 |
| NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams |
省略可能なパラメーター。 |
| NetworkSecurityPerimeterConfigurationsOperations |
ネットワークSecurityPerimeterConfigurations操作を表すインターフェース。 |
| NetworkSecurityPerimeterConfigurationsReconcileOptionalParams |
省略可能なパラメーター。 |
| NetworkSecurityProfile |
ネットワーク セキュリティ境界構成プロファイル |
| Operation |
リソース プロバイダー操作 API から返される REST API 操作の詳細 |
| OperationDisplay |
作戦のためのローカライズされた表示情報。 |
| OperationsListOptionalParams |
省略可能なパラメーター。 |
| OperationsOperations |
操作操作を表すインターフェイス。 |
| PageSettings |
byPage メソッドのオプション |
| PagedAsyncIterableIterator |
完了とページごとの非同期反復を可能にするインターフェイス。 |
| PrivateEndpointConnection |
Azure AI 検索 サービスへの既存のプライベート エンドポイント接続について説明します。 |
| PrivateEndpointConnectionProperties |
検索サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。 |
| PrivateEndpointConnectionPropertiesPrivateEndpoint |
Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。 |
| PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState |
プライベート エンドポイントへの既存の Azure Private Link サービス接続の現在の状態について説明します。 |
| PrivateEndpointConnectionsDeleteOptionalParams |
省略可能なパラメーター。 |
| PrivateEndpointConnectionsGetOptionalParams |
省略可能なパラメーター。 |
| PrivateEndpointConnectionsListByServiceOptionalParams |
省略可能なパラメーター。 |
| PrivateEndpointConnectionsOperations |
PrivateEndpointConnections 操作を表すインターフェイス。 |
| PrivateEndpointConnectionsUpdateOptionalParams |
省略可能なパラメーター。 |
| PrivateLinkResource |
Azure AI 検索 サービスでサポートされているプライベート リンク リソースについて説明します。 |
| PrivateLinkResourceProperties |
Azure AI 検索 サービスでサポートされているプライベート リンク リソースのプロパティについて説明します。 特定の API バージョンの場合、これは共有プライベート リンク リソースの作成時に "サポートされている" groupIds を表します。 |
| PrivateLinkResourcesListSupportedOptionalParams |
省略可能なパラメーター。 |
| PrivateLinkResourcesOperations |
PrivateLinkResources 操作を表すインターフェイス。 |
| ProvisioningIssue |
ネットワーク セキュリティ境界構成のプロビジョニングの問題について説明します |
| ProvisioningIssueProperties |
ネットワーク セキュリティ境界 (NSP) 構成のプロビジョニングの問題の詳細。 リソース プロバイダーは、検出された個別の問題ごとに個別のプロビジョニングの問題要素を生成し、意味のある独特の説明と、適切な suggestedResourceIds と suggestedAccessRules を含める必要があります |
| ProxyResource |
Azure Resource Manager プロキシ リソースのリソース モデル定義。 タグと場所はありません |
| QueryKey |
インデックスのドキュメント コレクションに対する読み取り専用アクセス許可を伝達する、特定の Azure AI 検索 サービスの API キーについて説明します。 |
| QueryKeysCreateOptionalParams |
省略可能なパラメーター。 |
| QueryKeysDeleteOptionalParams |
省略可能なパラメーター。 |
| QueryKeysListBySearchServiceOptionalParams |
省略可能なパラメーター。 |
| QueryKeysOperations |
QueryKeys操作を表すインターフェース。 |
| QuotaUsageResult |
特定の SKU のクォータ使用量について説明します。 |
| QuotaUsageResultName |
SKU名情報、識別子およびローカライズされた表示名が含まれます。 |
| Resource |
すべての Azure Resource Manager リソースの応答で返される共通フィールド |
| ResourceAssociation |
リソースの関連付けに関する情報 |
| RestorePollerOptions | |
| SearchManagementClientOptionalParams |
クライアントの省略可能なパラメーター。 |
| SearchManagementRequestOptions |
model interface SearchManagementRequestOptions |
| SearchService |
Azure AI 検索 サービスとその現在の状態について説明します。 |
| SearchServiceProperties |
検索サービスのプロパティ。 |
| SearchServiceUpdate |
Azure AI 検索 サービスの更新に使用されるパラメーター。 |
| ServicesCheckNameAvailabilityOptionalParams |
省略可能なパラメーター。 |
| ServicesCreateOrUpdateOptionalParams |
省略可能なパラメーター。 |
| ServicesDeleteOptionalParams |
省略可能なパラメーター。 |
| ServicesGetOptionalParams |
省略可能なパラメーター。 |
| ServicesListByResourceGroupOptionalParams |
省略可能なパラメーター。 |
| ServicesListBySubscriptionOptionalParams |
省略可能なパラメーター。 |
| ServicesOperations |
サービス操作を表すインターフェイス。 |
| ServicesUpdateOptionalParams |
省略可能なパラメーター。 |
| ServicesUpgradeOptionalParams |
省略可能なパラメーター。 |
| ShareablePrivateLinkResourceProperties |
Azure AI 検索 でサポートされているプライベート リンク サービスにオンボードされたリソースの種類のプロパティについて説明します。 |
| ShareablePrivateLinkResourceType |
Azure AI 検索 でサポートされているプライベート リンク サービスにオンボードされたリソースの種類について説明します。 |
| SharedPrivateLinkResource |
Azure AI 検索 サービスによって管理される共有プライベート リンク リソースについて説明します。 |
| SharedPrivateLinkResourceProperties |
Azure AI 検索 サービスによって管理されている既存の共有プライベート リンク リソースのプロパティについて説明します。 |
| SharedPrivateLinkResourcesCreateOrUpdateOptionalParams |
省略可能なパラメーター。 |
| SharedPrivateLinkResourcesDeleteOptionalParams |
省略可能なパラメーター。 |
| SharedPrivateLinkResourcesGetOptionalParams |
省略可能なパラメーター。 |
| SharedPrivateLinkResourcesListByServiceOptionalParams |
省略可能なパラメーター。 |
| SharedPrivateLinkResourcesOperations |
SharedPrivateLinkResources操作を表すインターフェース。 |
| SimplePollerLike |
実行時間の長い操作をポーリングするために使用できる単純なポーリングツール。 |
| Sku |
課金レートと容量の制限を決定する検索サービスの SKU を定義します。 |
| SystemData |
リソースの作成と最後の変更に関連するメタデータ。 |
| TrackedResource |
Azure Resource Manager のリソース モデル定義は、"タグ" と "場所" を持つ最上位リソースを追跡しました |
| UsageBySubscriptionSkuOptionalParams |
省略可能なパラメーター。 |
| UsagesListBySubscriptionOptionalParams |
省略可能なパラメーター。 |
| UsagesOperations |
Usages 操作を表すインターフェイス。 |
| UserAssignedIdentity |
ユーザー割り当て ID プロパティ |
型エイリアス
| AadAuthFailureMode |
認証に失敗した要求に対して検索サービスのデータ プレーン API が送信する応答について説明します。 |
| AccessRuleDirection |
アクセスの方向規則 サービスでサポートされている既知の値
受信: セキュリティで保護されたリソースへの受信ネットワーク トラフィックに適用されます。 |
| ActionType |
拡張可能な列挙。 アクションの種類を示します。 "内部" とは、内部のみの API に対するアクションを指します。 サービスでサポートされている既知の値内部: アクションは内部専用 API 用です。 |
| AdminKeyKind |
AdminKeyKindの種類 |
| AzureSupportedClouds |
文字列リテラル型としてのクラウド設定でサポートされている値 |
| ComputeType |
既定のコンピューティングまたは Azure Confidential Compute を使用して検索サービスをサポートするように、このプロパティを構成します。 サービスでサポートされている既知の値
デフォルト:Default Computeでサービスを作成します。 |
| ContinuablePage |
結果のページを記述するインターフェイス。 |
| CreatedByType |
リソースを作成したエンティティの種類。 サービスでサポートされている既知の値
ユーザー: エンティティはユーザーによって作成されました。 |
| HostingMode |
Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'Default' または 'HighDensity' のいずれかです。 他のすべてのSKUの場合、この値は「デフォルト」である必要があります。 |
| IdentityType |
リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、システムによって作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 サービスでサポートされている既知の値
なし: 検索サービスに関連付けられている ID を削除する必要があることを示します。 |
| IssueType |
発行の種類 サービスでサポートされている既知の値
不明な: 不明な問題の種類 |
| KnowledgeRetrieval |
Azure AI 検索サービス上のエージェント検索の請求プランを指定します。 この構成は特定の地域で特定の価格帯でのみ利用可能です。 サービスでサポートされている既知の値
無料:検索サービスでの知識検索を可能にし、無料プランの範囲内で使用することを示します。 無料プランは知識検索依頼の量に上限があり、追加料金は無料です。 |
| NetworkSecurityPerimeterConfigurationProvisioningState |
作成または更新されるネットワーク セキュリティ境界構成のプロビジョニング状態。 サービスでサポートされている既知の値
成功:構成は正常にプロビジョニングされました。 |
| Origin |
操作の目的の実行プログラム。リソース ベースのアクセス制御 (RBAC) と監査ログ UX と同様です。 既定値は "user,system" です サービスでサポートされている既知の値
ユーザー: 操作がユーザーによって開始されたことを示します。 |
| PrivateLinkServiceConnectionProvisioningState |
プライベート リンク サービス接続のプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、不完全、または取り消しです。 サービスでサポートされている既知の値
の更新: プライベート リンク サービス接続は、他のリソースと共に作成され、完全に機能するように処理中です。 |
| PrivateLinkServiceConnectionStatus |
プライベート リンク サービス接続の状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。 |
| ProvisioningState |
検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービス容量の確立中に発生する中間状態です。 容量が設定されると、provisioningState が "Succeeded" または "Failed" に変わります。 クライアント アプリケーションは、Search Service の取得操作を使用して、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングして、操作が完了したタイミングを確認できます。 無料サービスを使用している場合、この値は検索サービスの作成呼び出しで直接 "Succeeded" として返される傾向があります。 これは、無料サービスで既に設定されている容量が使用されるためです。 |
| PublicNetworkAccess |
この値を '有効] に設定すると、既存の顧客リソースとテンプレートに対する重大な変更を回避できます。 「無効」に設定すると、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続が排他アクセス方法になります。 サービスでサポートされている既知の値
有効:検索サービスは公共インターネットから発信されるトラフィックからアクセス可能です。 |
| ResourceAssociationAccessMode |
リソース関連のアクセスモード サービスでサポートされている既知の値
強制: アクセス モードの適用 - アクセス チェックに失敗したリソースへのトラフィックがブロックされる |
| SearchBypass |
"ipRules" セクションで定義されている規則を回避できる受信トラフィックの発生元として考えられます。 サービスでサポートされている既知の値
なし: 'ipRules' セクションで定義されたルールをバイパスできないオリジンがないことを示します。 これが既定値です。 |
| SearchDataExfiltrationProtection |
サービス上で無効化された特定のデータ流出シナリオ。 サービスでサポートされている既知の値BlockAll: すべてのデータ流出シナリオが無効であることを示します。 |
| SearchEncryptionComplianceStatus |
CMK で暗号化されていないオブジェクトに関する検索サービスコンプライアンスの状態を返します。 サービスに暗号化されていないオブジェクトが複数あり、適用が有効になっている場合、サービスは非準拠としてマークされます。 |
| SearchEncryptionWithCmk |
カスタマー マネージド キーで暗号化されていないオブジェクトが検索サービスによって検出された場合に、検索サービスがコンプライアンスを適用する方法について説明します。 |
| SearchSemanticSearch |
Azure AI 検索サービスにおけるセマンティック検索の可用性および請求プランを規定しています。 この構成は特定の地域で特定の価格帯でのみ利用可能です。 サービスでサポートされている既知の値
disabled: 検索サービスに対してセマンティック リランカーが無効になっていることを示します。 |
| SearchServiceStatus |
検索サービスの状態。 可能な値は次のとおりです:"running": 検索サービスは実行中であり、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が最も高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスが無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 'stopped': 検索サービスが無効になっているサブスクリプション内にあります。 サービスが劣化、無効化、エラー状態にある場合、Azure AI 検索チームが根本的な問題を積極的に調査していることを意味します。 これらの状態の専用サービスは、プロビジョニングされた検索ユニットの数に基づいて引き続き課金されます。 |
| Severity |
問題の重大度。 サービスでサポートされている既知の値
警告:この問題は警告であり、設定の適用を妨げるものではありません。 |
| SharedPrivateLinkResourceProvisioningState |
共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。 サービスでサポートされている既知の値
更新中: 共有プライベート リンク リソースは、完全に機能するために他のリソースとともに作成中です。 |
| SharedPrivateLinkResourceStatus |
共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。 サービスでサポートされている既知の値
保留中: 共有プライベート リンク リソースが作成され、承認待ちです。 |
| SkuName |
検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 "basic": 最大 3 つのレプリカを含む専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': 標準に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが多い最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 「storage_optimized_l2」:パーティションあたり2TB、最大12パーティションをサポートします。 「サーバーレス」:自動スケーリング機能を備えたサーバーレス層。 サービスでサポートされている既知の値
無料: SLA 保証がなく、課金対象レベルで提供される機能のサブセットを備えた無料レベル。 |
| UnavailableNameReason |
名前が使用できない理由。 'Invalid' は、指定された名前が名前付け要件 (正しくない長さ、サポートされていない文字など) と一致しないことを示します。 'AlreadyExists' は、名前が既に使用されているため使用できないことを示します。 サービスでサポートされている既知の値
無効: 検索サービス名が名前付け要件と一致しません。 |
| UpgradeAvailable |
専用検索サービスがアップグレード可能かどうかを示します。 サービスでサポートされている既知の値
notAvailable:専用サービスでは現在アップグレードは利用できません。 |
列挙型
| AzureClouds |
Azure Cloud 環境を説明するための列挙式です。 |
| KnownAccessRuleDirection |
アクセスルールの方向 |
| KnownActionType |
拡張可能な列挙。 アクションの種類を示します。 "内部" とは、内部のみの API に対するアクションを指します。 |
| KnownComputeType |
既定のコンピューティングまたは Azure Confidential Compute を使用して検索サービスをサポートするように、このプロパティを構成します。 |
| KnownCreatedByType |
リソースを作成したエンティティの種類。 |
| KnownIdentityType |
リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、システムによって作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 |
| KnownIssueType |
問題の種類 |
| KnownKnowledgeRetrieval |
Azure AI 検索サービス上のエージェント検索の請求プランを指定します。 この構成は特定の地域で特定の価格帯でのみ利用可能です。 |
| KnownNetworkSecurityPerimeterConfigurationProvisioningState |
作成または更新されるネットワーク セキュリティ境界構成のプロビジョニング状態。 |
| KnownOrigin |
操作の目的の実行プログラム。リソース ベースのアクセス制御 (RBAC) と監査ログ UX と同様です。 既定値は "user,system" です |
| KnownPrivateLinkServiceConnectionProvisioningState |
プライベート リンク サービス接続のプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、不完全、または取り消しです。 |
| KnownPublicNetworkAccess |
この値を '有効] に設定すると、既存の顧客リソースとテンプレートに対する重大な変更を回避できます。 「無効」に設定すると、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続が排他アクセス方法になります。 |
| KnownResourceAssociationAccessMode |
リソース関連付けのアクセス モード |
| KnownSearchBypass |
"ipRules" セクションで定義されている規則を回避できる受信トラフィックの発生元として考えられます。 |
| KnownSearchDataExfiltrationProtection |
サービス上で無効化された特定のデータ流出シナリオ。 |
| KnownSearchSemanticSearch |
Azure AI 検索サービスにおけるセマンティック検索の可用性および請求プランを規定しています。 この構成は特定の地域で特定の価格帯でのみ利用可能です。 |
| KnownSeverity |
問題の重大度。 |
| KnownSharedPrivateLinkResourceProvisioningState |
共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。 |
| KnownSharedPrivateLinkResourceStatus |
共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。 |
| KnownSkuName |
検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 "basic": 最大 3 つのレプリカを含む専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': 標準に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが多い最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 「storage_optimized_l2」:パーティションあたり2TB、最大12パーティションをサポートします。 「サーバーレス」:自動スケーリング機能を備えたサーバーレス層。 |
| KnownUnavailableNameReason |
名前が使用できない理由。 'Invalid' は、指定された名前が名前付け要件 (正しくない長さ、サポートされていない文字など) と一致しないことを示します。 'AlreadyExists' は、名前が既に使用されているため使用できないことを示します。 |
| KnownUpgradeAvailable |
専用検索サービスがアップグレード可能かどうかを示します。 |
| KnownVersions |
使用可能な API バージョン。 |
関数
| is |
RestError の Typeguard |
| restore |
別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。 |
変数
| Rest |
失敗したパイプライン要求のカスタム エラーの種類。 |
関数の詳細
isRestError(unknown)
RestError の Typeguard
function isRestError(e: unknown): e is RestErrorパラメーター
- e
-
unknown
catch 句によってキャッチされる何か。
返品
e is RestError
restorePoller<TResponse, TResult>(SearchManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。
function restorePoller<TResponse, TResult>(client: SearchManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>パラメーター
- client
- SearchManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
返品
PollerLike<OperationState<TResult>, TResult>