SearchServices インターフェイス

パッケージ:

com.microsoft.azure.management.search

public interface SearchServices extends SupportsCreating<SearchService.DefinitionStages.Blank>,SupportsListing,SupportsListingByResourceGroup,SupportsGettingByResourceGroup,SupportsGettingById,SupportsDeletingById,SupportsDeletingByResourceGroup,SupportsBatchCreation,HasManager,HasInner

Azure のSearch Service管理 API へのエントリ ポイント。

メソッドの概要

修飾子と型	メソッドと説明
CheckNameAvailabilityResult	checkNameAvailability(String name) 指定したSearch Service名が有効で使用可能かどうかを確認します。
Observable<CheckNameAvailabilityResult>	checkNameAvailabilityAsync(String name) Search Service名が有効で、非同期的に使用されていないかどうかを確認します。
ServiceFuture<CheckNameAvailabilityResult>	checkNameAvailabilityAsync(String name, ServiceCallback<CheckNameAvailabilityResult> callback) Search Service名が有効で、非同期的に使用されていないかどうかを確認します。
QueryKey	createQueryKey(String resourceGroupName, String searchServiceName, String name) プライマリまたはセカンダリの管理者 API キーを再生成します。 一度に再生成できるのは 1 つのキーのみです。
Observable<QueryKey>	createQueryKeyAsync(String resourceGroupName, String searchServiceName, String name) プライマリまたはセカンダリの管理者 API キーを再生成します。 一度に再生成できるのは 1 つのキーのみです。
void	deleteQueryKey(String resourceGroupName, String searchServiceName, String key) 指定したクエリ キーを削除します。 管理キーとは異なり、クエリ キーは再生成されません。 クエリ キーを再生成するには、キーを削除して再作成します。
Completable	deleteQueryKeyAsync(String resourceGroupName, String searchServiceName, String key) 指定したクエリ キーを削除します。 管理キーとは異なり、クエリ キーは再生成されません。 クエリ キーを再生成するには、キーを削除して再作成します。
AdminKeys	getAdminKeys(String resourceGroupName, String searchServiceName) 指定した Azure Search Serviceのプライマリおよびセカンダリ管理者 API キーを取得します。
Observable<AdminKeys>	getAdminKeysAsync(String resourceGroupName, String searchServiceName) 指定した Azure Search Serviceのプライマリおよびセカンダリ管理者 API キーを取得します。
List<QueryKey>	listQueryKeys(String resourceGroupName, String searchServiceName) 指定された Azure Search サービスのクエリ API キーの一覧を返します。
Observable<QueryKey>	listQueryKeysAsync(String resourceGroupName, String searchServiceName) 指定された Azure Search サービスのクエリ API キーの一覧を返します。
AdminKeys	regenerateAdminKeys(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind) プライマリまたはセカンダリの管理者 API キーを再生成します。 一度に再生成できるのは 1 つのキーのみです。
Observable<AdminKeys>	regenerateAdminKeysAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind) プライマリまたはセカンダリの管理者 API キーを再生成します。 一度に再生成できるのは 1 つのキーのみです。

継承メンバー

SupportsBatchCreation<ResourceT>.create(Creatable<ResourceT>... creatables) SupportsBatchCreation<ResourceT>.create(List<Creatable<ResourceT>> creatables) SupportsBatchCreation<ResourceT>.createAsync(Creatable<ResourceT>... creatables) SupportsBatchCreation<ResourceT>.createAsync(List<Creatable<ResourceT>> creatables) SupportsBatchCreation<ResourceT>.createAsync(ServiceCallback<CreatedResources<ResourceT>> callback, Creatable<ResourceT>... creatables) SupportsBatchCreation<ResourceT>.createAsync(final ServiceCallback<CreatedResources<ResourceT>> callback, List<Creatable<ResourceT>> creatables) SupportsCreating<T>.define(String name) SupportsDeletingById.deleteById(String id) SupportsDeletingById.deleteByIdAsync(String id, ServiceCallback<Void> callback) SupportsDeletingById.deleteByIdAsync(String id) SupportsDeletingByResourceGroup.deleteByResourceGroup(String resourceGroupName, String name) SupportsDeletingByResourceGroup.deleteByResourceGroupAsync(String resourceGroupName, String name, ServiceCallback<Void> callback) SupportsDeletingByResourceGroup.deleteByResourceGroupAsync(String resourceGroupName, String name) SupportsGettingById<T>.getById(String id) SupportsGettingById<T>.getByIdAsync(String id) SupportsGettingById<T>.getByIdAsync(String id, ServiceCallback<T> callback) SupportsGettingByResourceGroup<T>.getByResourceGroup(String resourceGroupName, String name) SupportsGettingByResourceGroup<T>.getByResourceGroupAsync(String resourceGroupName, String name) SupportsGettingByResourceGroup<T>.getByResourceGroupAsync(String resourceGroupName, String name, ServiceCallback<T> callback) HasInner<T>.inner() SupportsListing<T>.list() SupportsListing<T>.listAsync() SupportsListingByResourceGroup<T>.listByResourceGroup(String resourceGroupName) SupportsListingByResourceGroup<T>.listByResourceGroupAsync(String resourceGroupName) HasManager<ManagerT>.manager()

メソッドの詳細

checkNameAvailability

public CheckNameAvailabilityResult checkNameAvailability(String name)

指定したSearch Service名が有効で使用可能かどうかを確認します。

パラメーター:

name - チェックするSearch Service名

戻り値:

名前が使用可能かどうか、それ以外の場合は他の情報

checkNameAvailabilityAsync

public Observable checkNameAvailabilityAsync(String name)

Search Service名が有効で、非同期的に使用されていないかどうかを確認します。

パラメーター:

name - チェックするSearch Service名

戻り値:

この呼び出しの遅延計算の表現。名前が使用可能かどうか、または使用できない場合は他の情報を返します

checkNameAvailabilityAsync

public ServiceFuture checkNameAvailabilityAsync(String name, ServiceCallback callback)

Search Service名が有効で、非同期的に使用されていないかどうかを確認します。

パラメーター:

name - チェックするSearch Service名

callback - 成功または失敗時に呼び出すコールバック

戻り値:

要求を取り消すハンドル

createQueryKey

public QueryKey createQueryKey(String resourceGroupName, String searchServiceName, String name)

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

パラメーター:

resourceGroupName - 現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

searchServiceName - 指定したリソース グループに関連付けられている Azure Search Serviceの名前。

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

戻り値:

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

スロー:

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

CloudException - 要求がサーバーによって拒否された場合にスローされる

RuntimeException - 要求の送信に失敗した場合、他のすべてのラップされたチェック例外

createQueryKeyAsync

public Observable createQueryKeyAsync(String resourceGroupName, String searchServiceName, String name)

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

パラメーター:

resourceGroupName - 現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

searchServiceName - 指定したリソース グループに関連付けられている Azure Search Serviceの名前。

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

戻り値:

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

スロー:

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

deleteQueryKey

public void deleteQueryKey(String resourceGroupName, String searchServiceName, String key)

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

パラメーター:

resourceGroupName - 現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

searchServiceName - 指定したリソース グループに関連付けられている Azure Search Serviceの名前。

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

スロー:

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

CloudException - 要求がサーバーによって拒否された場合にスローされる

RuntimeException - 要求の送信に失敗した場合、他のすべてのラップされたチェック例外

deleteQueryKeyAsync

public Completable deleteQueryKeyAsync(String resourceGroupName, String searchServiceName, String key)

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

パラメーター:

resourceGroupName - 現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

searchServiceName - 指定したリソース グループに関連付けられている Azure Search Serviceの名前。

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

戻り値:

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

スロー:

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

getAdminKeys

public AdminKeys getAdminKeys(String resourceGroupName, String searchServiceName)

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

パラメーター:

resourceGroupName - 現在のサブスクリプション内のリソース グループの名前。この値は、Azure Resource Manager API またはポータルから取得できます

searchServiceName - 指定したリソース グループに関連付けられている Azure Search Serviceの名前

戻り値:

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

スロー:

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

CloudException - 要求がサーバーによって拒否された場合にスローされる

RuntimeException - 要求の送信に失敗した場合、他のすべてのラップされたチェック例外

getAdminKeysAsync

public Observable getAdminKeysAsync(String resourceGroupName, String searchServiceName)

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

パラメーター:

resourceGroupName - 現在のサブスクリプション内のリソース グループの名前。この値は、Azure Resource Manager API またはポータルから取得できます

searchServiceName - 指定したリソース グループに関連付けられている Azure Search Serviceの名前

戻り値:

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

スロー:

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

listQueryKeys

public List listQueryKeys(String resourceGroupName, String searchServiceName)

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

パラメーター:

resourceGroupName - 現在のサブスクリプション内のリソース グループの名前。この値は、Azure Resource Manager API またはポータルから取得できます

searchServiceName - 指定したリソース グループに関連付けられている Azure Search Serviceの名前

戻り値:

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

スロー:

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

CloudException - 要求がサーバーによって拒否された場合にスローされる

RuntimeException - 要求の送信に失敗した場合、他のすべてのラップされたチェック例外

listQueryKeysAsync

public Observable listQueryKeysAsync(String resourceGroupName, String searchServiceName)

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

パラメーター:

resourceGroupName - 現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

searchServiceName - 指定したリソース グループに関連付けられている Azure Search Serviceの名前。

戻り値:

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

スロー:

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

regenerateAdminKeys

public AdminKeys regenerateAdminKeys(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)

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

パラメーター:

resourceGroupName - 現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

searchServiceName - 指定したリソース グループに関連付けられている Azure Search Serviceの名前。

keyKind - 再生成するキーを指定します。 有効な値には、'primary' と 'secondary' が含まれます。 使用可能な値は、'primary'、'secondary' です。

戻り値:

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

スロー:

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

CloudException - 要求がサーバーによって拒否された場合にスローされる

RuntimeException - 要求の送信に失敗した場合、他のすべてのラップされたチェック例外

regenerateAdminKeysAsync

public Observable regenerateAdminKeysAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)

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

パラメーター:

resourceGroupName - 現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

searchServiceName - 指定したリソース グループに関連付けられている Azure Search Serviceの名前。

keyKind - 再生成するキーを指定します。 有効な値には、'primary' と 'secondary' が含まれます。 使用可能な値は、'primary'、'secondary' です。

戻り値:

AdminKeyResultInner オブジェクトに対して監視可能な

スロー:

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