SearchServices Interface

Pacote:

com.microsoft.azure.management.search

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

Ponto de entrada para serviço Pesquisa API de gerenciamento no Azure.

Resumo do método

Modificador e tipo	Método e descrição
CheckNameAvailabilityResult	checkNameAvailability(String name) Verifica se o nome serviço Pesquisa especificado é válido e disponível.
Observable<CheckNameAvailabilityResult>	checkNameAvailabilityAsync(String name) Verifica se serviço Pesquisa nome é válido e não está em uso de forma assíncrona.
ServiceFuture<CheckNameAvailabilityResult>	checkNameAvailabilityAsync(String name, ServiceCallback<CheckNameAvailabilityResult> callback) Verifica se serviço Pesquisa nome é válido e não está em uso de forma assíncrona.
QueryKey	createQueryKey(String resourceGroupName, String searchServiceName, String name) Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.
Observable<QueryKey>	createQueryKeyAsync(String resourceGroupName, String searchServiceName, String name) Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.
void	deleteQueryKey(String resourceGroupName, String searchServiceName, String key) Exclui a chave de consulta especificada. Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta consiste em excluí-la e recriá-la.
Completable	deleteQueryKeyAsync(String resourceGroupName, String searchServiceName, String key) Exclui a chave de consulta especificada. Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta consiste em excluí-la e recriá-la.
AdminKeys	getAdminKeys(String resourceGroupName, String searchServiceName) Obtém as chaves da API de administrador primário e secundário para o serviço Pesquisa do Azure especificado.
Observable<AdminKeys>	getAdminKeysAsync(String resourceGroupName, String searchServiceName) Obtém as chaves da API de administrador primário e secundário para o serviço Pesquisa do Azure especificado.
List<QueryKey>	listQueryKeys(String resourceGroupName, String searchServiceName) Retorna a lista de chaves de API de consulta para o serviço Azure Search especificado.
Observable<QueryKey>	listQueryKeysAsync(String resourceGroupName, String searchServiceName) Retorna a lista de chaves de API de consulta para o serviço Azure Search especificado.
AdminKeys	regenerateAdminKeys(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind) Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.
Observable<AdminKeys>	regenerateAdminKeysAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind) Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.

Membros herdados

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()

Detalhes do método

checkNameAvailability

public CheckNameAvailabilityResult checkNameAvailability(String name)

Verifica se o nome serviço Pesquisa especificado é válido e disponível.

Parâmetros:

name - o nome serviço Pesquisa para marcar

Retornos:

se o nome está disponível e outras informações, se não

checkNameAvailabilityAsync

public Observable checkNameAvailabilityAsync(String name)

Verifica se serviço Pesquisa nome é válido e não está em uso de forma assíncrona.

Parâmetros:

name - o nome serviço Pesquisa para marcar

Retornos:

uma representação da computação adiada dessa chamada, retornando se o nome está disponível ou outras informações, se não

checkNameAvailabilityAsync

public ServiceFuture checkNameAvailabilityAsync(String name, ServiceCallback callback)

Verifica se serviço Pesquisa nome é válido e não está em uso de forma assíncrona.

Parâmetros:

name - o nome serviço Pesquisa para marcar

callback - o retorno de chamada para chamar em caso de êxito ou falha

Retornos:

um identificador para cancelar a solicitação

createQueryKey

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

Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.

Parâmetros:

resourceGroupName - O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

searchServiceName - O nome do serviço Pesquisa do Azure associado ao grupo de recursos especificado.

name - O nome da nova chave de API de consulta.

Retornos:

o objeto QueryKey se tiver êxito.

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

CloudException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

createQueryKeyAsync

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

Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.

Parâmetros:

resourceGroupName - O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

searchServiceName - O nome do serviço Pesquisa do Azure associado ao grupo de recursos especificado.

name - O nome da nova chave de API de consulta.

Retornos:

uma representação da computação futura dessa chamada

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

deleteQueryKey

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

Exclui a chave de consulta especificada. Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta consiste em excluí-la e recriá-la.

Parâmetros:

resourceGroupName - O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

searchServiceName - O nome do serviço Pesquisa do Azure associado ao grupo de recursos especificado.

key - A chave de consulta a ser excluída. As chaves de consulta são identificadas por valor, não por nome.

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

CloudException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

deleteQueryKeyAsync

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

Exclui a chave de consulta especificada. Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta consiste em excluí-la e recriá-la.

Parâmetros:

resourceGroupName - O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

searchServiceName - O nome do serviço Pesquisa do Azure associado ao grupo de recursos especificado.

key - A chave de consulta a ser excluída. As chaves de consulta são identificadas por valor, não por nome.

Retornos:

uma representação da computação futura dessa chamada

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

getAdminKeys

public AdminKeys getAdminKeys(String resourceGroupName, String searchServiceName)

Obtém as chaves da API de administrador primário e secundário para o serviço Pesquisa do Azure especificado.

Parâmetros:

resourceGroupName - O nome do grupo de recursos dentro da assinatura atual; você pode obter esse valor da API de Resource Manager do Azure ou do portal

searchServiceName - O nome do serviço Pesquisa do Azure associado ao grupo de recursos especificado

Retornos:

o objeto AdminKeys se tiver êxito

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

CloudException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

getAdminKeysAsync

public Observable getAdminKeysAsync(String resourceGroupName, String searchServiceName)

Obtém as chaves da API de administrador primário e secundário para o serviço Pesquisa do Azure especificado.

Parâmetros:

resourceGroupName - O nome do grupo de recursos dentro da assinatura atual; você pode obter esse valor da API de Resource Manager do Azure ou do portal

searchServiceName - O nome do serviço Pesquisa do Azure associado ao grupo de recursos especificado

Retornos:

uma representação da computação futura dessa chamada

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

listQueryKeys

public List listQueryKeys(String resourceGroupName, String searchServiceName)

Retorna a lista de chaves de API de consulta para o serviço Azure Search especificado.

Parâmetros:

resourceGroupName - O nome do grupo de recursos dentro da assinatura atual; você pode obter esse valor da API de Resource Manager do Azure ou do portal

searchServiceName - O nome do serviço Pesquisa do Azure associado ao grupo de recursos especificado

Retornos:

o objeto List<QueryKey> se tiver êxito

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

CloudException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

listQueryKeysAsync

public Observable listQueryKeysAsync(String resourceGroupName, String searchServiceName)

Retorna a lista de chaves de API de consulta para o serviço Azure Search especificado.

Parâmetros:

resourceGroupName - O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

searchServiceName - O nome do serviço Pesquisa do Azure associado ao grupo de recursos especificado.

Retornos:

uma representação da computação futura dessa chamada

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

regenerateAdminKeys

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

Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.

Parâmetros:

resourceGroupName - O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

searchServiceName - O nome do serviço Pesquisa do Azure associado ao grupo de recursos especificado.

keyKind - Especifica qual chave deve ser regenerada. Os valores válidos incluem 'primary' e 'secondary'. Os valores possíveis incluem: 'primary', 'secondary'

Retornos:

o objeto AdminKeys se for bem-sucedido.

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação

CloudException - gerado se a solicitação for rejeitada pelo servidor

RuntimeException - todas as outras exceções verificadas encapsuladas se a solicitação não for enviada

regenerateAdminKeysAsync

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

Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.

Parâmetros:

resourceGroupName - O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

searchServiceName - O nome do serviço Pesquisa do Azure associado ao grupo de recursos especificado.

keyKind - Especifica qual chave deve ser regenerada. Os valores válidos incluem 'primary' e 'secondary'. Os valores possíveis incluem: 'primary', 'secondary'

Retornos:

o observável para o objeto AdminKeyResultInner

Gera:

IllegalArgumentException - gerado se os parâmetros falharem na validação