SearchServiceUpdate interface

パッケージ:

@azure/arm-search

Azure AI Search サービスの更新に使用されるパラメーター。

Extends

Resource

プロパティ

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

継承されたプロパティ

id	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
name	リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
type	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

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 Search サービスのエンドポイント。

endpoint?: string

プロパティ値

string

eTag

更新中にオプティミスティック コンカレンシー制御に使用できるサービスの etag を表すシステム生成プロパティ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

eTag?: string

プロパティ値

string

hostingMode

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

hostingMode?: HostingMode

プロパティ値

HostingMode

identity

検索サービス ID の詳細。 null 値は、検索サービスに ID が割り当てられていないことを示します。

identity?: Identity

プロパティ値

Identity

location

リソースの地理的な場所。 これは、サポートされ、登録されている Azure geo リージョンの 1 つである必要があります (たとえば、米国西部、米国東部、東南アジアなど)。 このプロパティは、新しいリソースを作成するときに必要です。

location?: string

プロパティ値

string

networkRuleSet

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

networkRuleSet?: NetworkRuleSet

プロパティ値

NetworkRuleSet

partitionCount

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

partitionCount?: number

プロパティ値

number

privateEndpointConnections

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

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 Search SKU に対してのみ可能です。

semanticSearch?: string

プロパティ値

string

serviceUpgradedAt

検索サービスが最後にアップグレードされた日時。 このフィールドは、サービスが初めてアップグレードされるまで null になります。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

serviceUpgradedAt?: Date

プロパティ値

Date

sharedPrivateLinkResources

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

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

プロパティ値

SharedPrivateLinkResource[]

sku

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

sku?: Sku

プロパティ値

Sku

status

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

status?: SearchServiceStatus

プロパティ値

SearchServiceStatus

statusDetails

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

statusDetails?: string

プロパティ値

string

tags

Azure portal でリソースを分類するのに役立つタグ。

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

プロパティ値

{[propertyName: string]: string}

upgradeAvailable

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

upgradeAvailable?: string

プロパティ値

string

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

id

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

id?: string

プロパティ値

string

継承元Resource.id

name

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

name?: string

プロパティ値

string

継承元Resource.name

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

systemData?: SystemData

プロパティ値

SystemData

resource.systemData から継承

type

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

type?: string

プロパティ値

string

継承元Resource.type