次の方法で共有


Services interface

サービスを表すインターフェイス。

メソッド

beginCreateOrUpdate(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)

指定されたリソース グループ内の検索サービスを作成または更新します。 検索サービスが既に存在する場合は、すべてのプロパティが指定された値で更新されます。

beginCreateOrUpdateAndWait(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)

指定されたリソース グループ内の検索サービスを作成または更新します。 検索サービスが既に存在する場合は、すべてのプロパティが指定された値で更新されます。

checkNameAvailability(string, ServicesCheckNameAvailabilityOptionalParams)

指定された検索サービス名を使用できるかどうかを確認します。 Search Service名はサービス URI ( の一部であるため、グローバルに一意である必要があります。https://.search.windows.net).

delete(string, string, ServicesDeleteOptionalParams)

指定されたリソース グループ内の検索サービスとそれに関連付けられているリソースを削除します。

get(string, string, ServicesGetOptionalParams)

指定されたリソース グループ内の指定された名前を持つ検索サービスを取得します。

listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)

指定したリソース グループ内のすべての Search サービスの一覧を取得します。

listBySubscription(ServicesListBySubscriptionOptionalParams)

指定されたサブスクリプション内のすべての Search サービスの一覧を取得します。

update(string, string, SearchServiceUpdate, ServicesUpdateOptionalParams)

特定のリソース グループ内の既存の検索サービスを更新します。

メソッドの詳細

beginCreateOrUpdate(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)

指定されたリソース グループ内の検索サービスを作成または更新します。 検索サービスが既に存在する場合は、すべてのプロパティが指定された値で更新されます。

function beginCreateOrUpdate(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SearchService>, SearchService>>

パラメーター

resourceGroupName

string

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

searchServiceName

string

作成または更新するAzure Cognitive Search サービスの名前。 Search Service名には小文字、数字、またはダッシュのみを含める必要があり、最初の 2 文字または最後の 1 文字としてダッシュを使用することはできません。連続したダッシュを含めることはできません。また、長さは 2 から 60 文字にする必要があります。 Search Service名はサービス URI ( の一部であるため、グローバルに一意である必要があります。https://.search.windows.net). サービスの作成後にサービス名を変更することはできません。

service
SearchService

作成または更新する検索サービスの定義。

options
ServicesCreateOrUpdateOptionalParams

options パラメーター。

戻り値

Promise<@azure/core-lro.SimplePollerLike<OperationState<SearchService>, SearchService>>

beginCreateOrUpdateAndWait(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)

指定されたリソース グループ内の検索サービスを作成または更新します。 検索サービスが既に存在する場合は、すべてのプロパティが指定された値で更新されます。

function beginCreateOrUpdateAndWait(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<SearchService>

パラメーター

resourceGroupName

string

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

searchServiceName

string

作成または更新するAzure Cognitive Search サービスの名前。 Search Service名には小文字、数字、またはダッシュのみを含める必要があり、最初の 2 文字または最後の 1 文字としてダッシュを使用することはできません。連続したダッシュを含めることはできません。また、長さは 2 から 60 文字にする必要があります。 Search Service名はサービス URI ( の一部であるため、グローバルに一意である必要があります。https://.search.windows.net). サービスの作成後にサービス名を変更することはできません。

service
SearchService

作成または更新する検索サービスの定義。

options
ServicesCreateOrUpdateOptionalParams

options パラメーター。

戻り値

Promise<SearchService>

checkNameAvailability(string, ServicesCheckNameAvailabilityOptionalParams)

指定された検索サービス名を使用できるかどうかを確認します。 Search Service名はサービス URI ( の一部であるため、グローバルに一意である必要があります。https://.search.windows.net).

function checkNameAvailability(name: string, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityOutput>

パラメーター

name

string

検証する検索サービス名。 Search Service名には小文字、数字、またはダッシュのみを含める必要があり、最初の 2 文字または最後の 1 文字としてダッシュを使用することはできません。連続したダッシュを含めることはできません。また、長さは 2 から 60 文字にする必要があります。

options
ServicesCheckNameAvailabilityOptionalParams

options パラメーター。

戻り値

delete(string, string, ServicesDeleteOptionalParams)

指定されたリソース グループ内の検索サービスとそれに関連付けられているリソースを削除します。

function delete(resourceGroupName: string, searchServiceName: string, options?: ServicesDeleteOptionalParams): Promise<void>

パラメーター

resourceGroupName

string

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

searchServiceName

string

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

options
ServicesDeleteOptionalParams

options パラメーター。

戻り値

Promise<void>

get(string, string, ServicesGetOptionalParams)

指定されたリソース グループ内の指定された名前を持つ検索サービスを取得します。

function get(resourceGroupName: string, searchServiceName: string, options?: ServicesGetOptionalParams): Promise<SearchService>

パラメーター

resourceGroupName

string

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

searchServiceName

string

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

options
ServicesGetOptionalParams

options パラメーター。

戻り値

Promise<SearchService>

listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)

指定したリソース グループ内のすべての Search サービスの一覧を取得します。

function listByResourceGroup(resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>

パラメーター

resourceGroupName

string

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

options
ServicesListByResourceGroupOptionalParams

options パラメーター。

戻り値

listBySubscription(ServicesListBySubscriptionOptionalParams)

指定されたサブスクリプション内のすべての Search サービスの一覧を取得します。

function listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>

パラメーター

options
ServicesListBySubscriptionOptionalParams

options パラメーター。

戻り値

update(string, string, SearchServiceUpdate, ServicesUpdateOptionalParams)

特定のリソース グループ内の既存の検索サービスを更新します。

function update(resourceGroupName: string, searchServiceName: string, service: SearchServiceUpdate, options?: ServicesUpdateOptionalParams): Promise<SearchService>

パラメーター

resourceGroupName

string

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

searchServiceName

string

更新するAzure Cognitive Search サービスの名前。

service
SearchServiceUpdate

更新する検索サービスの定義。

options
ServicesUpdateOptionalParams

options パラメーター。

戻り値

Promise<SearchService>