Services interface
サービスを表すインターフェイス。
メソッド
メソッドの詳細
beginCreateOrUpdate(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)
指定されたリソース グループ内の検索サービスを作成または更新します。 検索サービスが既に存在する場合は、すべてのプロパティが指定された値で更新されます。
function beginCreateOrUpdate(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SearchService>, SearchService>>パラメーター
- resourceGroupName
-
string
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
- searchServiceName
-
string
作成または更新する Azure AI Search サービスの名前。 検索サービス名には、小文字、数字、またはダッシュのみを含める必要があり、最初の 2 文字または最後の 1 文字としてダッシュを使用することはできません。連続するダッシュを含めることはできません。また、長さは 2 ~ 60 文字にする必要があります。 検索サービス名は、サービス URI (https://<name>.search.windows.net) の一部であるため、一意である必要があります。 サービスの作成後にサービス名を変更することはできません。
- service
- SearchService
作成または更新する検索サービスの定義。
オプション パラメーター。
返品
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 Resource Manager API またはポータルから取得できます。
- searchServiceName
-
string
作成または更新する Azure AI Search サービスの名前。 検索サービス名には、小文字、数字、またはダッシュのみを含める必要があり、最初の 2 文字または最後の 1 文字としてダッシュを使用することはできません。連続するダッシュを含めることはできません。また、長さは 2 ~ 60 文字にする必要があります。 検索サービス名は、サービス URI (https://<name>.search.windows.net) の一部であるため、一意である必要があります。 サービスの作成後にサービス名を変更することはできません。
- service
- SearchService
作成または更新する検索サービスの定義。
オプション パラメーター。
返品
Promise<SearchService>
beginUpgrade(string, string, ServicesUpgradeOptionalParams)
Azure AI Search サービスを利用可能な最新バージョンにアップグレードします。
function beginUpgrade(resourceGroupName: string, searchServiceName: string, options?: ServicesUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<SearchService>, SearchService>>パラメーター
- resourceGroupName
-
string
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
- searchServiceName
-
string
指定したリソース グループに関連付けられている Azure AI Search サービスの名前。
- options
- ServicesUpgradeOptionalParams
オプション パラメーター。
返品
Promise<@azure/core-lro.SimplePollerLike<OperationState<SearchService>, SearchService>>
beginUpgradeAndWait(string, string, ServicesUpgradeOptionalParams)
Azure AI Search サービスを利用可能な最新バージョンにアップグレードします。
function beginUpgradeAndWait(resourceGroupName: string, searchServiceName: string, options?: ServicesUpgradeOptionalParams): Promise<SearchService>パラメーター
- resourceGroupName
-
string
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
- searchServiceName
-
string
指定したリソース グループに関連付けられている Azure AI Search サービスの名前。
- options
- ServicesUpgradeOptionalParams
オプション パラメーター。
返品
Promise<SearchService>
checkNameAvailability(string, ServicesCheckNameAvailabilityOptionalParams)
指定された検索サービス名を使用できるかどうかを確認します。 検索サービス名は、サービス URI (https://<name>.search.windows.net) の一部であるため、グローバルに一意である必要があります。
function checkNameAvailability(name: string, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityOutput>パラメーター
- name
-
string
検証する検索サービス名。 検索サービス名には、小文字、数字、またはダッシュのみを含める必要があり、最初の 2 文字または最後の 1 文字としてダッシュを使用することはできません。連続するダッシュを含めることはできません。また、長さは 2 ~ 60 文字にする必要があります。
オプション パラメーター。
返品
Promise<CheckNameAvailabilityOutput>
delete(string, string, ServicesDeleteOptionalParams)
特定のリソース グループ内の検索サービスとそれに関連付けられているリソースを削除します。
function delete(resourceGroupName: string, searchServiceName: string, options?: ServicesDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
- searchServiceName
-
string
指定したリソース グループに関連付けられている Azure AI Search サービスの名前。
- options
- ServicesDeleteOptionalParams
オプション パラメーター。
返品
Promise<void>
get(string, string, ServicesGetOptionalParams)
指定されたリソース グループ内の指定された名前を持つ検索サービスを取得します。
function get(resourceGroupName: string, searchServiceName: string, options?: ServicesGetOptionalParams): Promise<SearchService>パラメーター
- resourceGroupName
-
string
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
- searchServiceName
-
string
指定したリソース グループに関連付けられている Azure AI Search サービスの名前。
- options
- ServicesGetOptionalParams
オプション パラメーター。
返品
Promise<SearchService>
listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)
指定されたリソース グループ内のすべての Search サービスの一覧を取得します。
function listByResourceGroup(resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>パラメーター
- resourceGroupName
-
string
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
オプション パラメーター。
返品
listBySubscription(ServicesListBySubscriptionOptionalParams)
指定されたサブスクリプション内のすべての Search サービスの一覧を取得します。
function listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>パラメーター
オプション パラメーター。
返品
update(string, string, SearchServiceUpdate, ServicesUpdateOptionalParams)
指定されたリソース グループ内の既存の検索サービスを更新します。
function update(resourceGroupName: string, searchServiceName: string, service: SearchServiceUpdate, options?: ServicesUpdateOptionalParams): Promise<SearchService>パラメーター
- resourceGroupName
-
string
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
- searchServiceName
-
string
更新する Azure AI Search サービスの名前。
- service
- SearchServiceUpdate
更新する検索サービスの定義。
- options
- ServicesUpdateOptionalParams
オプション パラメーター。
返品
Promise<SearchService>