SearchServiceProperties interface

パッケージ:

@azure/arm-search

検索サービスのプロパティ。

プロパティ

authOptions	検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
computeType	既定のコンピューティングまたは Azure Confidential Compute を使用して検索サービスをサポートするように、このプロパティを構成します。
dataExfiltrationProtections	検索サービスに対して明示的に許可されていないデータ流出シナリオの一覧。 現在、サポートされる唯一の値は、将来計画されるより細かい制御を使用して、すべての可能なデータ エクスポート シナリオを無効にする 'All' です。
disableLocalAuth	true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。
encryptionWithCmk	検索サービス内でカスタマー マネージャー キーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。
endpoint	Azure AI 検索 サービスのエンドポイント。
eTag	更新中にオプティミスティック コンカレンシー制御に使用できるサービスの etag を表すシステム生成プロパティ。
hostingMode	Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'Default' または 'HighDensity' のいずれかです。 他のすべてのSKUの場合、この値は「デフォルト」である必要があります。
knowledgeRetrieval	Azure AI 検索サービス上のエージェント検索の請求プランを指定します。 この構成は特定の地域で特定の価格帯でのみ利用可能です。
networkRuleSet	Azure AI 検索 サービスに到達する方法を決定するネットワーク固有のルール。
partitionCount	専用検索サービスのパーティション数;指定されれば、1、2、3、4、6、または12となります。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。
privateEndpointConnections	Azure AI 検索サービスへのプライベートエンドポイント接続のリスト。
provisioningState	検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービス容量の確立中に発生する中間状態です。 容量が設定されると、provisioningState が "Succeeded" または "Failed" に変わります。 クライアント アプリケーションは、Search Service の取得操作を使用して、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングして、操作が完了したタイミングを確認できます。 無料サービスを使用している場合、この値は検索サービスの作成呼び出しで直接 "Succeeded" として返される傾向があります。 これは、無料サービスで既に設定されている容量が使用されるためです。
publicNetworkAccess	この値を '有効] に設定すると、既存の顧客リソースとテンプレートに対する重大な変更を回避できます。 「無効」に設定すると、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続が排他アクセス方法になります。
replicaCount	専用検索サービス内のレプリカ数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 ~ 3 の値にする必要があります。
semanticSearch	Azure AI 検索サービスにおけるセマンティック検索の可用性および請求プランを規定しています。 この構成は特定の地域で特定の価格帯でのみ利用可能です。
serviceUpgradedAt	検索サービスが最後にアップグレードされた日時。 このフィールドは、サービスが初めてアップグレードされるまで null になります。
sharedPrivateLinkResources	Azure AI 検索サービスによって管理されている共有プライベートリンクリソースのリスト。
status	検索サービスの状態。 可能な値は次のとおりです:"running": 検索サービスは実行中であり、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が最も高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスが無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 'stopped': 検索サービスが無効になっているサブスクリプション内にあります。 サービスが劣化、無効化、エラー状態にある場合、Azure AI 検索チームが根本的な問題を積極的に調査していることを意味します。 これらの状態の専用サービスは、プロビジョニングされた検索ユニットの数に基づいて引き続き課金されます。
statusDetails	検索サービスの状態の詳細。
upgradeAvailable	検索サービスにアップグレードが利用可能かどうかを示します。

プロパティの詳細

authOptions

検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。

authOptions?: DataPlaneAuthOptions

プロパティ値

DataPlaneAuthOptions

computeType

既定のコンピューティングまたは Azure Confidential Compute を使用して検索サービスをサポートするように、このプロパティを構成します。

computeType?: string

プロパティ値

string

dataExfiltrationProtections

検索サービスに対して明示的に許可されていないデータ流出シナリオの一覧。 現在、サポートされる唯一の値は、将来計画されるより細かい制御を使用して、すべての可能なデータ エクスポート シナリオを無効にする 'All' です。

dataExfiltrationProtections?: string[]

プロパティ値

string[]

disableLocalAuth

true に設定すると、検索サービスの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これを true に設定することはできません。

disableLocalAuth?: boolean

プロパティ値

boolean

encryptionWithCmk

検索サービス内でカスタマー マネージャー キーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。

encryptionWithCmk?: EncryptionWithCmk

プロパティ値

EncryptionWithCmk

endpoint

Azure AI 検索 サービスのエンドポイント。

endpoint?: string

プロパティ値

string

eTag

更新中にオプティミスティック コンカレンシー制御に使用できるサービスの etag を表すシステム生成プロパティ。

eTag?: string

プロパティ値

string

hostingMode

Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'Default' または 'HighDensity' のいずれかです。 他のすべてのSKUの場合、この値は「デフォルト」である必要があります。

hostingMode?: HostingMode

プロパティ値

HostingMode

knowledgeRetrieval

Azure AI 検索サービス上のエージェント検索の請求プランを指定します。 この構成は特定の地域で特定の価格帯でのみ利用可能です。

knowledgeRetrieval?: string

プロパティ値

string

networkRuleSet

Azure AI 検索 サービスに到達する方法を決定するネットワーク固有のルール。

networkRuleSet?: NetworkRuleSet

プロパティ値

NetworkRuleSet

partitionCount

専用検索サービスのパーティション数;指定されれば、1、2、3、4、6、または12となります。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。

partitionCount?: number

プロパティ値

number

privateEndpointConnections

Azure AI 検索サービスへのプライベートエンドポイント接続のリスト。

privateEndpointConnections?: PrivateEndpointConnection[]

プロパティ値

PrivateEndpointConnection[]

provisioningState

検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービス容量の確立中に発生する中間状態です。 容量が設定されると、provisioningState が "Succeeded" または "Failed" に変わります。 クライアント アプリケーションは、Search Service の取得操作を使用して、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングして、操作が完了したタイミングを確認できます。 無料サービスを使用している場合、この値は検索サービスの作成呼び出しで直接 "Succeeded" として返される傾向があります。 これは、無料サービスで既に設定されている容量が使用されるためです。

provisioningState?: ProvisioningState

プロパティ値

ProvisioningState

publicNetworkAccess

この値を '有効] に設定すると、既存の顧客リソースとテンプレートに対する重大な変更を回避できます。 「無効」に設定すると、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続が排他アクセス方法になります。

publicNetworkAccess?: string

プロパティ値

string

replicaCount

専用検索サービス内のレプリカ数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 ~ 3 の値にする必要があります。

replicaCount?: number

プロパティ値

number

semanticSearch

Azure AI 検索サービスにおけるセマンティック検索の可用性および請求プランを規定しています。 この構成は特定の地域で特定の価格帯でのみ利用可能です。

semanticSearch?: string

プロパティ値

string

serviceUpgradedAt

検索サービスが最後にアップグレードされた日時。 このフィールドは、サービスが初めてアップグレードされるまで null になります。

serviceUpgradedAt?: Date

プロパティ値

Date

sharedPrivateLinkResources

Azure AI 検索サービスによって管理されている共有プライベートリンクリソースのリスト。

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

プロパティ値

SharedPrivateLinkResource[]

status

検索サービスの状態。 可能な値は次のとおりです:"running": 検索サービスは実行中であり、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が最も高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスが無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 'stopped': 検索サービスが無効になっているサブスクリプション内にあります。 サービスが劣化、無効化、エラー状態にある場合、Azure AI 検索チームが根本的な問題を積極的に調査していることを意味します。 これらの状態の専用サービスは、プロビジョニングされた検索ユニットの数に基づいて引き続き課金されます。

status?: SearchServiceStatus

プロパティ値

SearchServiceStatus

statusDetails

検索サービスの状態の詳細。

statusDetails?: string

プロパティ値

string

upgradeAvailable

検索サービスにアップグレードが利用可能かどうかを示します。

upgradeAvailable?: string

プロパティ値

string