Compartilhar via

Services interface

  • Referência
Pacote:
@azure/arm-search

Interface que representa um Serviços.

Métodos

beginCreateOrUpdate(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)

Cria ou atualiza um serviço de pesquisa no grupo de recursos especificado. Se o serviço de pesquisa já existir, todas as propriedades serão atualizadas com os valores fornecidos.
beginCreateOrUpdateAndWait(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)

Cria ou atualiza um serviço de pesquisa no grupo de recursos especificado. Se o serviço de pesquisa já existir, todas as propriedades serão atualizadas com os valores fornecidos.
checkNameAvailability(string, ServicesCheckNameAvailabilityOptionalParams)

Verifica se o nome do serviço de pesquisa fornecido está disponível ou não para uso. Os nomes do serviço de pesquisa devem ser globalmente exclusivos, pois fazem parte do URI do serviço (https://.search.windows.net).
delete(string, string, ServicesDeleteOptionalParams)

Exclui um serviço de pesquisa no grupo de recursos especificado, juntamente com seus recursos associados.
get(string, string, ServicesGetOptionalParams)

Obtém o serviço de pesquisa com o nome fornecido no grupo de recursos fornecido.
listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)

Obtém uma lista de todos os serviços de pesquisa no grupo de recursos especificado.
listBySubscription(ServicesListBySubscriptionOptionalParams)

Obtém uma lista de todos os serviços de Pesquisa na assinatura fornecida.
update(string, string, SearchServiceUpdate, ServicesUpdateOptionalParams)

Atualiza um serviço de pesquisa existente no grupo de recursos especificado.

Detalhes do método

beginCreateOrUpdate(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)

Cria ou atualiza um serviço de pesquisa no grupo de recursos especificado. Se o serviço de pesquisa já existir, todas as propriedades serão atualizadas com os valores fornecidos.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no portal.

searchServiceName

string

O nome do serviço do Azure Cognitive Search a ser criado ou atualizado. Os nomes do serviço de pesquisa devem conter apenas letras minúsculas, dígitos ou traços, não podem usar traços como os dois primeiros ou últimos caracteres, não podem conter traços consecutivos e devem ter entre 2 e 60 caracteres de comprimento. Os nomes do serviço de pesquisa devem ser globalmente exclusivos, pois fazem parte do URI do serviço (https://.search.windows.net). Não é possível alterar o nome do serviço após a criação do serviço.

service
SearchService

A definição do serviço de pesquisa a ser criado ou atualizado.

options
ServicesCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

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

beginCreateOrUpdateAndWait(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)

Cria ou atualiza um serviço de pesquisa no grupo de recursos especificado. Se o serviço de pesquisa já existir, todas as propriedades serão atualizadas com os valores fornecidos.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no portal.

searchServiceName

string

O nome do serviço do Azure Cognitive Search a ser criado ou atualizado. Os nomes do serviço de pesquisa devem conter apenas letras minúsculas, dígitos ou traços, não podem usar traços como os dois primeiros ou últimos caracteres, não podem conter traços consecutivos e devem ter entre 2 e 60 caracteres de comprimento. Os nomes do serviço de pesquisa devem ser globalmente exclusivos, pois fazem parte do URI do serviço (https://.search.windows.net). Não é possível alterar o nome do serviço após a criação do serviço.

service
SearchService

A definição do serviço de pesquisa a ser criado ou atualizado.

options
ServicesCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<SearchService>

checkNameAvailability(string, ServicesCheckNameAvailabilityOptionalParams)

Verifica se o nome do serviço de pesquisa fornecido está disponível ou não para uso. Os nomes do serviço de pesquisa devem ser globalmente exclusivos, pois fazem parte do URI do serviço (https://.search.windows.net).

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

Parâmetros

name

string

O nome do serviço de pesquisa a ser validado. Os nomes do serviço de pesquisa devem conter apenas letras minúsculas, dígitos ou traços, não podem usar traços como os dois primeiros ou últimos caracteres, não podem conter traços consecutivos e devem ter entre 2 e 60 caracteres de comprimento.

options
ServicesCheckNameAvailabilityOptionalParams

Os parâmetros de opções.

Retornos

Promise<CheckNameAvailabilityOutput>

delete(string, string, ServicesDeleteOptionalParams)

Exclui um serviço de pesquisa no grupo de recursos especificado, juntamente com seus recursos associados.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no portal.

searchServiceName

string

O nome do serviço do Azure Cognitive Search associado ao grupo de recursos especificado.

options
ServicesDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, string, ServicesGetOptionalParams)

Obtém o serviço de pesquisa com o nome fornecido no grupo de recursos fornecido.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no portal.

searchServiceName

string

O nome do serviço do Azure Cognitive Search associado ao grupo de recursos especificado.

options
ServicesGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<SearchService>

listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)

Obtém uma lista de todos os serviços de pesquisa no grupo de recursos especificado.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no portal.

options
ServicesListByResourceGroupOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>

listBySubscription(ServicesListBySubscriptionOptionalParams)

Obtém uma lista de todos os serviços de Pesquisa na assinatura fornecida.

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

Parâmetros

options
ServicesListBySubscriptionOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>

update(string, string, SearchServiceUpdate, ServicesUpdateOptionalParams)

Atualiza um serviço de pesquisa existente no grupo de recursos especificado.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no portal.

searchServiceName

string

O nome do serviço do Azure Cognitive Search a ser atualizado.

service
SearchServiceUpdate

A definição do serviço de pesquisa a ser atualizado.

options
ServicesUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<SearchService>