次の方法で共有

SearchService インターフェイス

  • リファレンス
パッケージ:
com.microsoft.azure.management.search

public interface SearchService extends GroupableResource<SearchServiceManager, SearchServiceInner>,Refreshable,Updatable<SearchService.Update>

Azure レジストリの不変のクライアント側表現。

メソッドの概要

修飾子と型 メソッドと説明
QueryKey createQueryKey(String name)

プライマリまたはセカンダリの管理 API キーを再生成します。

一度に再生成できるのは 1 つのキーのみです。
Observable<QueryKey> createQueryKeyAsync(String name)

プライマリまたはセカンダリの管理者 API キーを再生成します。

一度に再生成できるのは 1 つのキーのみです。
void deleteQueryKey(String key)

指定したクエリ キーを削除します。

管理キーとは異なり、クエリ キーは再生成されません。 クエリ キーを再生成するには、キーを削除して再作成します。
Completable deleteQueryKeyAsync(String key)

指定したクエリ キーを削除します。

管理キーとは異なり、クエリ キーは再生成されません。 クエリ キーを再生成するには、キーを削除して再作成します。
AdminKeys getAdminKeys()

指定した Azure Search Serviceのプライマリおよびセカンダリ管理者 API キー。
Observable<AdminKeys> getAdminKeysAsync()

指定した Azure Search Serviceのプライマリおよびセカンダリ管理者 API キー。
HostingMode hostingMode()

ホスティング モードの値。

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

指定された Azure Search サービスのクエリ API キーの一覧を返します。
Observable<QueryKey> listQueryKeysAsync()

指定された Azure Search サービスのクエリ API キーの一覧を返します。
int partitionCount()
ProvisioningState provisioningState()

Search Serviceで最後に実行されたプロビジョニング操作の状態。

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

プライマリまたはセカンダリの管理者 API キーを再生成します。

一度に再生成できるのは 1 つのキーのみです。
Observable<AdminKeys> regenerateAdminKeysAsync(AdminKeyKind keyKind)

プライマリまたはセカンダリの管理者 API キーを再生成します。 一度に再生成できるのは 1 つのキーのみです。
int replicaCount()
Sku sku()
SearchServiceStatus status()

Search Serviceの状態。

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

継承メンバー

HasId.id() HasInner<T>.inner() Indexable.key() HasManager<ManagerT>.manager() HasName.name() Refreshable<T>.refresh() Refreshable<T>.refreshAsync() Resource.region() Resource.regionName() HasResourceGroup.resourceGroupName() Resource.tags() Resource.type() Updatable<T>.update()

メソッドの詳細

createQueryKey

public QueryKey createQueryKey(String name)

プライマリまたはセカンダリの管理 API キーを再生成します。

一度に再生成できるのは 1 つのキーのみです。

パラメーター:

name - 新しいクエリ API キーの名前。

戻り値:

成功した場合は <QueryKey> オブジェクト

スロー:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる
CloudException - 要求がサーバーによって拒否された場合にスローされる
RuntimeException - 要求の送信に失敗した場合に、他のすべてのラップされたチェック例外

createQueryKeyAsync

public Observable createQueryKeyAsync(String name)

プライマリまたはセカンダリの管理者 API キーを再生成します。

一度に再生成できるのは 1 つのキーのみです。

パラメーター:

name - 新しいクエリ API キーの名前。

戻り値:

この呼び出しの将来の計算の表現

スロー:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

deleteQueryKey

public void deleteQueryKey(String key)

指定したクエリ キーを削除します。

管理キーとは異なり、クエリ キーは再生成されません。 クエリ キーを再生成するには、キーを削除して再作成します。

パラメーター:

key - 削除するクエリ キー。 クエリ キーは、名前ではなく値によって識別されます。

スロー:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる
CloudException - 要求がサーバーによって拒否された場合にスローされる
RuntimeException - 要求の送信に失敗した場合、他のすべてのラップされたチェック例外

deleteQueryKeyAsync

public Completable deleteQueryKeyAsync(String key)

指定したクエリ キーを削除します。

管理キーとは異なり、クエリ キーは再生成されません。 クエリ キーを再生成するには、キーを削除して再作成します。

パラメーター:

key - 削除するクエリ キー。 クエリ キーは、名前ではなく値によって識別されます。

戻り値:

この呼び出しの将来の計算の表現

スロー:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

getAdminKeys

public AdminKeys getAdminKeys()

指定した Azure Search Serviceのプライマリおよびセカンダリ管理者 API キー。

戻り値:

成功した場合は AdminKeys オブジェクト

スロー:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる
CloudException - 要求がサーバーによって拒否された場合にスローされる
RuntimeException - 要求の送信に失敗した場合、他のすべてのラップされたチェック例外

getAdminKeysAsync

public Observable getAdminKeysAsync()

指定した Azure Search Serviceのプライマリおよびセカンダリ管理者 API キー。

戻り値:

この呼び出しの将来の計算の表現

スロー:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

hostingMode

public HostingMode hostingMode()

ホスティング モードの値。

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

戻り値:

ホスティング モードの値。

listQueryKeys

public List listQueryKeys()

指定された Azure Search サービスのクエリ API キーの一覧を返します。

戻り値:

成功した場合の QueryKey> オブジェクトの一覧表示<

スロー:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる
CloudException - 要求がサーバーによって拒否された場合にスローされる
RuntimeException - 要求の送信に失敗した場合、他のすべてのラップされたチェック例外

listQueryKeysAsync

public Observable listQueryKeysAsync()

指定された Azure Search サービスのクエリ API キーの一覧を返します。

戻り値:

List<QueryKey> オブジェクトに対して監視可能な

スロー:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

partitionCount

public int partitionCount()

戻り値:

サービスによって使用されるパーティションの数

provisioningState

public ProvisioningState provisioningState()

Search Serviceで最後に実行されたプロビジョニング操作の状態。

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

戻り値:

リソースのプロビジョニング状態

regenerateAdminKeys

public AdminKeys regenerateAdminKeys(AdminKeyKind keyKind)

プライマリまたはセカンダリの管理者 API キーを再生成します。

一度に再生成できるのは 1 つのキーのみです。

パラメーター:

keyKind - は、再生成するキーを指定します

戻り値:

成功した場合は AdminKeys オブジェクト

スロー:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる
CloudException - 要求がサーバーによって拒否された場合にスローされる
RuntimeException - 要求の送信に失敗した場合、他のすべてのラップされたチェック例外

regenerateAdminKeysAsync

public Observable regenerateAdminKeysAsync(AdminKeyKind keyKind)

プライマリまたはセカンダリの管理者 API キーを再生成します。 一度に再生成できるのは 1 つのキーのみです。

パラメーター:

keyKind - 再生成するキーを指定します。

戻り値:

この呼び出しの将来の計算の表現

スロー:

IllegalArgumentException - パラメーターが検証に失敗した場合にスローされる

replicaCount

public int replicaCount()

戻り値:

サービスによって使用されるレプリカの数

sku

public Sku sku()

戻り値:

サービスの SKU の種類

status

public SearchServiceStatus status()

Search Serviceの状態。

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

戻り値:

サービスの状態

statusDetails

public String statusDetails()

戻り値:

状態の詳細。

適用対象