ServicesOperations Classe

Aviso

NÃO instancie essa classe diretamente.

Em vez disso, você deve acessar as operações a seguir por meio de

SearchManagementClient's

Atributo <xref:services>.

Herança

builtins.object

ServicesOperations

Construtor

ServicesOperations(*args, **kwargs)

Métodos

begin_create_or_update	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.
check_name_availability	Verifica se o nome do serviço de pesquisa fornecido está disponível ou não para uso. serviço Pesquisa nomes devem ser globalmente exclusivos, pois fazem parte do URI de serviço (https://<name>.search.windows.net).
delete	Exclui um serviço de pesquisa no grupo de recursos fornecido, juntamente com seus recursos associados.
get	Obtém o serviço de pesquisa com o nome fornecido no grupo de recursos fornecido.
list_by_resource_group	Obtém uma lista de todos os serviços de pesquisa no grupo de recursos especificado.
list_by_subscription	Obtém uma lista de todos os serviços de pesquisa na assinatura fornecida.
update	Atualizações um serviço de pesquisa existente no grupo de recursos especificado.

begin_create_or_update

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.

begin_create_or_update(resource_group_name: str, search_service_name: str, service: _models.SearchService, search_management_request_options: _models.SearchManagementRequestOptions | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.SearchService]

Parâmetros

resource_group_name

str

Obrigatório

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. Obrigatórios.

search_service_name

str

Obrigatório

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

service

SearchService ou IO

Obrigatório

A definição do serviço de pesquisa a ser criado ou atualizado. É um tipo de modelo ou um tipo de E/S. Obrigatórios.

search_management_request_options

SearchManagementRequestOptions

Obrigatório

Grupo de parâmetros. O valor padrão é Nenhum.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller de um estado salvo.

polling

bool ou PollingMethod

Por padrão, seu método de sondagem será ARMPolling. Passe em False para que esta operação não sondar ou passe seu próprio objeto de sondagem inicializado para uma estratégia de sondagem pessoal.

polling_interval

int

Tempo de espera padrão entre duas pesquisas para operações LRO se nenhum cabeçalho Retry-After estiver presente.

Retornos

Uma instância de LROPoller que retorna SearchService ou o resultado de cls(response)

Tipo de retorno

LROPoller[SearchService]

Exceções

HttpResponseError

check_name_availability

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

check_name_availability(name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> CheckNameAvailabilityOutput

Parâmetros

name

str

Obrigatório

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

search_management_request_options

SearchManagementRequestOptions

Obrigatório

Grupo de parâmetros. O valor padrão é Nenhum.

type

str

O tipo do recurso cujo nome deve ser validado. Esse valor deve ser sempre 'searchServices'. O valor padrão é "searchServices". Observe que substituir esse valor padrão pode resultar em um comportamento sem suporte.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

CheckNameAvailabilityOutput ou o resultado de cls(response)

Tipo de retorno

CheckNameAvailabilityOutput

Exceções

HttpResponseError

delete

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

delete(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> None

Parâmetros

resource_group_name

str

Obrigatório

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. Obrigatórios.

search_service_name

str

Obrigatório

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

search_management_request_options

SearchManagementRequestOptions

Obrigatório

Grupo de parâmetros. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Nenhum ou o resultado de cls(response)

Tipo de retorno

None

Exceções

HttpResponseError

get

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

get(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> SearchService

Parâmetros

resource_group_name

str

Obrigatório

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. Obrigatórios.

search_service_name

str

Obrigatório

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

search_management_request_options

SearchManagementRequestOptions

Obrigatório

Grupo de parâmetros. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

SearchService ou o resultado de cls(response)

Tipo de retorno

SearchService

Exceções

HttpResponseError

list_by_resource_group

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

list_by_resource_group(resource_group_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> Iterable[SearchService]

Parâmetros

resource_group_name

str

Obrigatório

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. Obrigatórios.

search_management_request_options

SearchManagementRequestOptions

Obrigatório

Grupo de parâmetros. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Um iterador como a instância do SearchService ou o resultado de cls(response)

Tipo de retorno

ItemPaged[SearchService]

Exceções

HttpResponseError

list_by_subscription

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

list_by_subscription(search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> Iterable[SearchService]

Parâmetros

search_management_request_options

SearchManagementRequestOptions

Obrigatório

Grupo de parâmetros. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Um iterador como a instância do SearchService ou o resultado de cls(response)

Tipo de retorno

ItemPaged[SearchService]

Exceções

HttpResponseError

update

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

update(resource_group_name: str, search_service_name: str, service: _models.SearchServiceUpdate, search_management_request_options: _models.SearchManagementRequestOptions | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SearchService

Parâmetros

resource_group_name

str

Obrigatório

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. Obrigatórios.

search_service_name

str

Obrigatório

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

service

SearchServiceUpdate ou IO

Obrigatório

A definição do serviço de pesquisa a ser atualizado. É um tipo de modelo ou um tipo de E/S. Obrigatórios.

search_management_request_options

SearchManagementRequestOptions

Obrigatório

Grupo de parâmetros. O valor padrão é Nenhum.

content_type

str

Tipo de conteúdo do Parâmetro do Corpo. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.

cls

callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

SearchService ou o resultado de cls(response)

Tipo de retorno

SearchService

Exceções

HttpResponseError

Atributos

models

models = <module 'azure.mgmt.search.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.5\\x64\\Lib\\site-packages\\azure\\mgmt\\search\\models\\__init__.py'>