Services interface

Balíček:

@azure/arm-search

Rozhraní představující služby

Metody

beginCreateOrUpdate(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)	Vytvoří nebo aktualizuje vyhledávací službu v dané skupině prostředků. Pokud vyhledávací služba již existuje, aktualizují se všechny vlastnosti s danými hodnotami.
beginCreateOrUpdateAndWait(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)	Vytvoří nebo aktualizuje vyhledávací službu v dané skupině prostředků. Pokud vyhledávací služba již existuje, aktualizují se všechny vlastnosti s danými hodnotami.
beginUpgrade(string, string, ServicesUpgradeOptionalParams)	Upgraduje službu Azure AI Search na nejnovější dostupnou verzi.
beginUpgradeAndWait(string, string, ServicesUpgradeOptionalParams)	Upgraduje službu Azure AI Search na nejnovější dostupnou verzi.
checkNameAvailability(string, ServicesCheckNameAvailabilityOptionalParams)	Zkontroluje, jestli je daný název vyhledávací služby k dispozici pro použití. Názvy vyhledávacích služeb musí být globálně jedinečné, protože jsou součástí identifikátoru URI služby (https://< name.search.windows.net>).
delete(string, string, ServicesDeleteOptionalParams)	Odstraní vyhledávací službu v dané skupině prostředků spolu s přidruženými prostředky.
get(string, string, ServicesGetOptionalParams)	Získá vyhledávací službu s daným názvem v dané skupině prostředků.
listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)	Získá seznam všech vyhledávacích služeb v dané skupině prostředků.
listBySubscription(ServicesListBySubscriptionOptionalParams)	Získá seznam všech vyhledávacích služeb v daném předplatném.
update(string, string, SearchServiceUpdate, ServicesUpdateOptionalParams)	Aktualizuje existující vyhledávací službu v dané skupině prostředků.

Podrobnosti metody

beginCreateOrUpdate(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)

Vytvoří nebo aktualizuje vyhledávací službu v dané skupině prostředků. Pokud vyhledávací služba již existuje, aktualizují se všechny vlastnosti s danými hodnotami.

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

Parametry

resourceGroupName

string

Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

searchServiceName

string

Název služby Azure AI Search, která se má vytvořit nebo aktualizovat. Názvy vyhledávacích služeb musí obsahovat jenom malá písmena, číslice nebo pomlčky, nesmí jako první dva nebo poslední jeden znak používat pomlčku, nesmí obsahovat po sobě jdoucí pomlčky a musí mít délku 2 až 60 znaků. Názvy vyhledávacích služeb musí být jedinečné, protože jsou součástí identifikátoru URI služby (https://< name.search.windows.net>). Po vytvoření služby nelze změnit název služby.

service

SearchService

Definice vyhledávací služby pro vytvoření nebo aktualizaci.

options

ServicesCreateOrUpdateOptionalParams

Parametry možností.

Návraty

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

beginCreateOrUpdateAndWait(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)

Vytvoří nebo aktualizuje vyhledávací službu v dané skupině prostředků. Pokud vyhledávací služba již existuje, aktualizují se všechny vlastnosti s danými hodnotami.

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

Parametry

resourceGroupName

string

Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

searchServiceName

string

Název služby Azure AI Search, která se má vytvořit nebo aktualizovat. Názvy vyhledávacích služeb musí obsahovat jenom malá písmena, číslice nebo pomlčky, nesmí jako první dva nebo poslední jeden znak používat pomlčku, nesmí obsahovat po sobě jdoucí pomlčky a musí mít délku 2 až 60 znaků. Názvy vyhledávacích služeb musí být jedinečné, protože jsou součástí identifikátoru URI služby (https://< name.search.windows.net>). Po vytvoření služby nelze změnit název služby.

service

SearchService

Definice vyhledávací služby pro vytvoření nebo aktualizaci.

options

ServicesCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<SearchService>

beginUpgrade(string, string, ServicesUpgradeOptionalParams)

Upgraduje službu Azure AI Search na nejnovější dostupnou verzi.

function beginUpgrade(resourceGroupName: string, searchServiceName: string, options?: ServicesUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<SearchService>, SearchService>>

Parametry

resourceGroupName

string

Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

searchServiceName

string

Název služby Azure AI Search přidružené k zadané skupině prostředků.

options

ServicesUpgradeOptionalParams

Parametry možností.

Návraty

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

beginUpgradeAndWait(string, string, ServicesUpgradeOptionalParams)

Upgraduje službu Azure AI Search na nejnovější dostupnou verzi.

function beginUpgradeAndWait(resourceGroupName: string, searchServiceName: string, options?: ServicesUpgradeOptionalParams): Promise<SearchService>

Parametry

resourceGroupName

string

Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

searchServiceName

string

Název služby Azure AI Search přidružené k zadané skupině prostředků.

options

ServicesUpgradeOptionalParams

Parametry možností.

Návraty

Promise<SearchService>

checkNameAvailability(string, ServicesCheckNameAvailabilityOptionalParams)

Zkontroluje, jestli je daný název vyhledávací služby k dispozici pro použití. Názvy vyhledávacích služeb musí být globálně jedinečné, protože jsou součástí identifikátoru URI služby (https://< name.search.windows.net>).

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

Parametry

name

string

Název vyhledávací služby, který chcete ověřit. Názvy vyhledávacích služeb musí obsahovat jenom malá písmena, číslice nebo pomlčky, nesmí jako první dva nebo poslední jeden znak používat pomlčku, nesmí obsahovat po sobě jdoucí pomlčky a musí mít délku 2 až 60 znaků.

options

ServicesCheckNameAvailabilityOptionalParams

Parametry možností.

Návraty

Promise<CheckNameAvailabilityOutput>

delete(string, string, ServicesDeleteOptionalParams)

Odstraní vyhledávací službu v dané skupině prostředků spolu s přidruženými prostředky.

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

Parametry

resourceGroupName

string

Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

searchServiceName

string

Název služby Azure AI Search přidružené k zadané skupině prostředků.

options

ServicesDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

get(string, string, ServicesGetOptionalParams)

Získá vyhledávací službu s daným názvem v dané skupině prostředků.

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

Parametry

resourceGroupName

string

Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

searchServiceName

string

Název služby Azure AI Search přidružené k zadané skupině prostředků.

options

ServicesGetOptionalParams

Parametry možností.

Návraty

Promise<SearchService>

listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)

Získá seznam všech vyhledávacích služeb v dané skupině prostředků.

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

Parametry

resourceGroupName

string

Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

options

ServicesListByResourceGroupOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>

listBySubscription(ServicesListBySubscriptionOptionalParams)

Získá seznam všech vyhledávacích služeb v daném předplatném.

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

Parametry

options

ServicesListBySubscriptionOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>

update(string, string, SearchServiceUpdate, ServicesUpdateOptionalParams)

Aktualizuje existující vyhledávací službu v dané skupině prostředků.

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

Parametry

resourceGroupName

string

Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

searchServiceName

string

Název služby Azure AI Search, která se má aktualizovat.

service

SearchServiceUpdate

Definice vyhledávací služby, která se má aktualizovat.

options

ServicesUpdateOptionalParams

Parametry možností.

Návraty

Promise<SearchService>