models パッケージ

クラス

AdminKeyResult	特定のAzure Cognitive Search サービスのプライマリおよびセカンダリ管理者 API キーを含む応答。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
AsyncOperationResult	実行時間の長い非同期共有プライベート リンク リソース操作の詳細。
CheckNameAvailabilityInput	チェック名可用性 API の入力。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
CheckNameAvailabilityOutput	チェック名可用性 API の出力。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
CloudErrorBody	エラー コードとメッセージを含む特定の API エラーについて説明します。
DataPlaneAadOrApiKeyAuthOption	AZURE Active Directory の API キーまたはアクセス トークンを認証に使用できることを示します。
DataPlaneAuthOptions	Search Serviceのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
EncryptionWithCmk	カスタマー マネージド キーを使用して検索サービス内のリソースを暗号化する方法を決定するポリシーについて説明します。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
Identity	リソースの ID。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
IpRule	Azure Cognitive Search サービスの IP 制限規則。
ListQueryKeysResult	特定のAzure Cognitive Search サービスのクエリ API キーを含む応答。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
NetworkRuleSet	Azure Cognitive Search サービスに到達する方法を決定するネットワーク固有の規則。
Operation	REST API 操作について説明します。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
OperationDisplay	操作を記述する オブジェクト。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
OperationListResult	REST API 操作を一覧表示する要求の結果。 操作の一覧と、次の結果セットを取得するための URL が含まれています。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
PrivateEndpointConnection	Azure Cognitive Search サービスへの既存のプライベート エンドポイント接続について説明します。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
PrivateEndpointConnectionListResult	プライベート エンドポイント接続の一覧を含む応答。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
PrivateEndpointConnectionProperties	Azure Cognitive Search サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。
PrivateEndpointConnectionPropertiesPrivateEndpoint	Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Azure プライベート エンドポイントへの既存のPrivate Link サービス接続の現在の状態について説明します。
PrivateLinkResource	Azure Cognitive Search サービスでサポートされているプライベート リンク リソースについて説明します。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
PrivateLinkResourceProperties	Azure Cognitive Search サービスでサポートされているプライベート リンク リソースのプロパティについて説明します。 特定の API バージョンの場合、これは共有プライベート リンク リソースを作成するときの "サポートされている" groupIds を表します。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
PrivateLinkResourcesResult	サポートされているPrivate Link リソースの一覧を含む応答。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
QueryKey	クエリ操作専用のアクセス許可を持つ特定のAzure Cognitive Search サービスの API キーについて説明します。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
Resource	すべての Azure Resource Manager リソースの応答で返される共通フィールド。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
SearchManagementRequestOptions	パラメーター グループ。
SearchService	Azure Cognitive Search サービスとその現在の状態について説明します。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchServiceListResult	Azure Cognitive Search サービスの一覧を含む応答。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
SearchServiceUpdate	Azure Cognitive Search サービスの更新に使用されるパラメーター。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
ShareablePrivateLinkResourceProperties	Azure Cognitive Searchでサポートされているプライベート リンク サービスにオンボードされているリソースの種類のプロパティについて説明します。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
ShareablePrivateLinkResourceType	Azure Cognitive Searchでサポートされているプライベート リンク サービスにオンボードされているリソースの種類について説明します。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
SharedPrivateLinkResource	Azure Cognitive Search サービスによって管理される共有Private Link リソースについて説明します。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
SharedPrivateLinkResourceListResult	共有Private Link リソースの一覧を含む応答。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。
SharedPrivateLinkResourceProperties	Azure Cognitive Search サービスによって管理される既存の共有Private Link リソースのプロパティについて説明します。
Sku	価格レベルと容量の制限を決定するAzure Cognitive Search サービスの SKU を定義します。
TrackedResource	Azure Resource Manager追跡される最上位リソースのリソース モデル定義。"タグ" と "場所" が含まれています。 変数はサーバーによってのみ設定され、要求の送信時には無視されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。

列挙型

AadAuthFailureMode	認証に失敗した要求に対してSearch Serviceのデータ プレーン API が送信する応答について説明します。
AdminKeyKind	AdminKeyKind。
HostingMode	Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は "default" である必要があります。
IdentityType	ID の種類。
PrivateLinkServiceConnectionProvisioningState	プライベート リンク サービス接続のプロビジョニング状態。 更新、削除、失敗、成功、または不完全のいずれかです。
PrivateLinkServiceConnectionStatus	プライベート リンク サービス接続の状態。 [保留中]、[承認済み]、[拒否済み]、または [切断済み] を指定できます。
ProvisioningState	検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービスの容量が確立されるときに発生する中間的な状態です。 容量が設定されると、provisioningState が 'succeeded' または 'failed' に変更されます。 クライアント アプリケーションは、Get Search Service 操作を使用して操作がいつ完了したのを確認することで、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングできます。 無料サービスを使用している場合、この値は、検索サービスの作成の呼び出しで "成功" として直接返される傾向があります。 これは、無料のサービスは既にセットアップされている容量を使用するためです。
PublicNetworkAccess	この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。
SearchEncryptionComplianceStatus	顧客以外の暗号化されたリソースを持つことに関して、検索サービスが準拠しているかどうかについて説明します。 サービスに複数の顧客以外の暗号化されたリソースがあり、"強制" が "有効" の場合、サービスは "非準拠" としてマークされます。
SearchEncryptionWithCmk	検索サービスで 1 つ以上の非顧客暗号化リソースを適用する方法について説明します。
SearchServiceStatus	検索サービスの状態。 指定できる値は、"実行中" です。検索サービスは実行されており、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスは無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 サービスが低下、無効、またはエラーの状態にある場合は、Azure Cognitive Search チームが基になる問題を積極的に調査していることを意味します。 この状態の専用サービスは、プロビジョニングされた検索単位数に基づいて、引き続き課金対象になります。
SharedPrivateLinkResourceAsyncOperationResult	実行時間の長い非同期共有プライベート リンク リソース操作の現在の状態。
SharedPrivateLinkResourceProvisioningState	共有プライベート リンク リソースのプロビジョニング状態。 更新、削除、失敗、成功、または不完全のいずれかです。
SharedPrivateLinkResourceStatus	共有プライベート リンク リソースの状態。 [保留中]、[承認済み]、[拒否済み]、または [切断] にすることができます。
SkuName	検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 'basic': 最大 3 つのレプリカを持つ専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': Standard に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを含む最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが追加された最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートしています。'
UnavailableNameReason	名前が使用できない理由。 'Invalid' は、指定された名前が名前付け要件 (正しくない長さ、サポートされていない文字など) と一致しないことを示します。 'AlreadyExists' は、名前が既に使用されているため使用できないことを示します。