SearchService interface

パッケージ:

@azure/arm-search

Azure Cognitive Search サービスとその現在の状態について説明します。

Extends

TrackedResource

プロパティ

authOptions	検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
disableLocalAuth	true に設定すると、検索サービスへの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これは true に設定できません。
encryptionWithCmk	検索サービス内のカスタマー マネージャー キーを使用したリソース (インデックスなど) の暗号化に関するポリシーを指定します。
hostingMode	Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は "default" である必要があります。
identity	リソースの ID。
networkRuleSet	Azure Cognitive Search サービスに到達する方法を決定するネットワーク固有の規則。
partitionCount	検索サービス内のパーティションの数。指定した場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。
privateEndpointConnections	Azure Cognitive Search サービスへのプライベート エンドポイント接続の一覧。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
provisioningState	検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービスの容量が確立されるときに発生する中間的な状態です。 容量が設定されると、provisioningState が 'succeeded' または 'failed' に変更されます。 クライアント アプリケーションは、Get Search Service 操作を使用して操作がいつ完了したのか確認することで、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングできます。 無料サービスを使用している場合、この値は、検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。 これは、無料のサービスは既にセットアップされている容量を使用するためです。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
publicNetworkAccess	この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。
replicaCount	検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 から 3 までの値である必要があります。
semanticSearch	セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定のAzure Cognitive Search SKU に対してのみ可能です。
sharedPrivateLinkResources	Azure Cognitive Search サービスによって管理される共有プライベート リンク リソースの一覧。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
sku	価格レベルと容量の制限を決定する Search Service の SKU。 このプロパティは、新しい Search Service を作成するときに必要です。
status	検索サービスの状態。 指定できる値は、"実行中" です。検索サービスは実行されており、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスは無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 サービスが低下、無効、またはエラーの状態にある場合は、Azure Cognitive Search チームが基になる問題を積極的に調査していることを意味します。 この状態の専用サービスは、プロビジョニングされた検索単位数に基づいて、引き続き課金対象になります。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
statusDetails	検索サービスの状態の詳細。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

継承されたプロパティ

id	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
location	リソースが保存されている地理的な場所
name	リソース名注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
tags	リソース タグ。
type	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

プロパティの詳細

authOptions

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

authOptions?: DataPlaneAuthOptions

プロパティ値

DataPlaneAuthOptions

disableLocalAuth

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

disableLocalAuth?: boolean

プロパティ値

boolean

encryptionWithCmk

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

encryptionWithCmk?: EncryptionWithCmk

プロパティ値

EncryptionWithCmk

hostingMode

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

hostingMode?: HostingMode

プロパティ値

HostingMode

identity

リソースの ID。

identity?: Identity

プロパティ値

Identity

networkRuleSet

Azure Cognitive Search サービスに到達する方法を決定するネットワーク固有の規則。

networkRuleSet?: NetworkRuleSet

プロパティ値

NetworkRuleSet

partitionCount

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

partitionCount?: number

プロパティ値

number

privateEndpointConnections

Azure Cognitive Search サービスへのプライベート エンドポイント接続の一覧。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

privateEndpointConnections?: PrivateEndpointConnection[]

プロパティ値

PrivateEndpointConnection[]

provisioningState

検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービスの容量が確立されるときに発生する中間的な状態です。 容量が設定されると、provisioningState が 'succeeded' または 'failed' に変更されます。 クライアント アプリケーションは、Get Search Service 操作を使用して操作がいつ完了したのか確認することで、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングできます。 無料サービスを使用している場合、この値は、検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。 これは、無料のサービスは既にセットアップされている容量を使用するためです。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

provisioningState?: ProvisioningState

プロパティ値

ProvisioningState

publicNetworkAccess

この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。

publicNetworkAccess?: PublicNetworkAccess

プロパティ値

PublicNetworkAccess

replicaCount

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

replicaCount?: number

プロパティ値

number

semanticSearch

セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定のAzure Cognitive Search SKU に対してのみ可能です。

semanticSearch?: string

プロパティ値

string

sharedPrivateLinkResources

Azure Cognitive Search サービスによって管理される共有プライベート リンク リソースの一覧。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

プロパティ値

SharedPrivateLinkResource[]

sku

価格レベルと容量の制限を決定する Search Service の SKU。 このプロパティは、新しい Search Service を作成するときに必要です。

sku?: Sku

プロパティ値

Sku

status

検索サービスの状態。 指定できる値は、"実行中" です。検索サービスは実行されており、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスは無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 サービスが低下、無効、またはエラーの状態にある場合は、Azure Cognitive Search チームが基になる問題を積極的に調査していることを意味します。 この状態の専用サービスは、プロビジョニングされた検索単位数に基づいて、引き続き課金対象になります。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

status?: SearchServiceStatus

プロパティ値

SearchServiceStatus

statusDetails

検索サービスの状態の詳細。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

statusDetails?: string

プロパティ値

string

継承されたプロパティの詳細

id

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

id?: string

プロパティ値

string

TrackedResource.id から継承

location

リソースが保存されている地理的な場所

location: string

プロパティ値

string

TrackedResource.locationから継承

name

リソース名注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

name?: string

プロパティ値

string

TrackedResource.name から継承

tags

リソース タグ。

tags?: {[propertyName: string]: string}

プロパティ値

{[propertyName: string]: string}

TrackedResource.tagsから継承

type

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

type?: string

プロパティ値

string

TrackedResource.typeから継承