ServicesOperations Classe

Aviso

NÃO instanciar esta classe diretamente.

Em vez disso, deve aceder às seguintes operações através de

SearchManagementClient's

<xref:services> atributo.

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 especificados.
check_name_availability	Verifica se o nome do serviço de pesquisa especificado está ou não disponível para utilização. Serviço de pesquisa nomes têm de ser globalmente exclusivos, uma vez que fazem parte do URI do serviço (https://<name>.search.windows.net).
delete	Elimina um serviço de pesquisa no grupo de recursos especificado, juntamente com os recursos associados.
get	Obtém o serviço de pesquisa com o nome especificado no grupo de recursos especificado.
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 subscrição especificada.
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 especificados.

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

Necessário

O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou do portal. Obrigatório.

search_service_name

str

Necessário

O nome do serviço Azure Cognitive Search a criar ou atualizar. Serviço de pesquisa nomes só têm de conter letras minúsculas, dígitos ou travessões, não podem utilizar traços como os dois primeiros ou últimos carateres, não podem conter travessões consecutivos e têm de ter entre 2 e 60 carateres de comprimento. Serviço de pesquisa nomes têm de ser globalmente exclusivos, uma vez que fazem parte do URI do serviço (https://<name>.search.windows.net). Não pode alterar o nome do serviço após a criação do serviço. Obrigatório.

service

SearchService ou IO

Necessário

A definição do serviço de pesquisa a criar ou atualizar. É um tipo de modelo ou um tipo de E/S. Obrigatório.

search_management_request_options

SearchManagementRequestOptions

Necessário

Grupo de parâmetros. O valor predefinido é Nenhum.

content_type

str

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

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

continuation_token

str

Um token de continuação para reiniciar um poller a partir de um estado guardado.

polling

bool ou PollingMethod

Por predefinição, o método de consulta será ARMPolling. Transmita Falso para que esta operação não seja consultada ou transmita o seu próprio objeto de consulta inicializado para uma estratégia de consulta pessoal.

polling_interval

int

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

Devoluções

Uma instância do LROPoller que devolve 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 especificado está ou não disponível para utilização. Serviço de pesquisa nomes têm de ser globalmente exclusivos, uma vez que fazem parte do URI do 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

Necessário

O nome do serviço de pesquisa a validar. Serviço de pesquisa nomes só têm de conter letras minúsculas, dígitos ou travessões, não podem utilizar traços como os dois primeiros ou últimos carateres, não podem conter travessões consecutivos e têm de ter entre 2 e 60 carateres de comprimento. Obrigatório.

search_management_request_options

SearchManagementRequestOptions

Necessário

Grupo de parâmetros. O valor predefinido é Nenhum.

type

str

O tipo de recurso cujo nome deve ser validado. Este valor tem de ser sempre "searchServices". O valor predefinido é "searchServices". Tenha em atenção que substituir este valor predefinido pode resultar num comportamento não suportado.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

CheckNameAvailabilityOutput ou o resultado de cls(response)

Tipo de retorno

CheckNameAvailabilityOutput

Exceções

HttpResponseError

delete

Elimina um serviço de pesquisa no grupo de recursos especificado, juntamente com os 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

Necessário

O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou do portal. Obrigatório.

search_service_name

str

Necessário

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

search_management_request_options

SearchManagementRequestOptions

Necessário

Grupo de parâmetros. O valor predefinido é Nenhum.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

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 especificado no grupo de recursos especificado.

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

Necessário

O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou do portal. Obrigatório.

search_service_name

str

Necessário

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

search_management_request_options

SearchManagementRequestOptions

Necessário

Grupo de parâmetros. O valor predefinido é Nenhum.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

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

Necessário

O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou do portal. Obrigatório.

search_management_request_options

SearchManagementRequestOptions

Necessário

Grupo de parâmetros. O valor predefinido é Nenhum.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

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 subscrição especificada.

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

Parâmetros

search_management_request_options

SearchManagementRequestOptions

Necessário

Grupo de parâmetros. O valor predefinido é Nenhum.

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

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

Necessário

O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou do portal. Obrigatório.

search_service_name

str

Necessário

O nome do serviço Azure Cognitive Search a atualizar. Obrigatório.

service

SearchServiceUpdate ou IO

Necessário

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

search_management_request_options

SearchManagementRequestOptions

Necessário

Grupo de parâmetros. O valor predefinido é Nenhum.

content_type

str

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

cls

callable

Um tipo ou função personalizado que será transmitido à resposta direta

Devoluções

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'>