ServicesOperations Класс

Предупреждение

НЕ создавать экземпляр этого класса напрямую.

Вместо этого вы должны получить доступ к следующим операциям с помощью

SearchManagementClient's

атрибут<xref:services> .

Наследование

builtins.object

ServicesOperations

Конструктор

ServicesOperations(*args, **kwargs)

Методы

begin_create_or_update	Создает или обновляет службу поиска в заданной группе ресурсов. Если служба поиска уже существует, все свойства будут обновлены с заданными значениями.
check_name_availability	Проверяет, доступно ли указанное имя службы поиска для использования. служба имена должны быть глобально уникальными, так как они являются частью URI службы (https://<name>.search.windows.net).
delete	Удаляет службу поиска в указанной группе ресурсов вместе со связанными с ней ресурсами.
get	Возвращает службу поиска с заданным именем в заданной группе ресурсов.
list_by_resource_group	Возвращает список всех служб поиска в заданной группе ресурсов.
list_by_subscription	Возвращает список всех служб поиска в заданной подписке.
update	Обновления существующую службу поиска в указанной группе ресурсов.

begin_create_or_update

Создает или обновляет службу поиска в заданной группе ресурсов. Если служба поиска уже существует, все свойства будут обновлены с заданными значениями.

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]

Параметры

resource_group_name

str

Обязательно

Имя группы ресурсов в текущей подписке. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала. Обязательный элемент.

search_service_name

str

Обязательно

Имя службы Когнитивный поиск Azure для создания или обновления. служба имена должны содержать только строчные буквы, цифры или тире, не могут использовать тире в качестве первых двух или последних символов, не могут содержать последовательные дефисы и должны иметь длину от 2 до 60 символов. служба имена должны быть глобально уникальными, так как они являются частью URI службы (https://<name>.search.windows.net). Имя службы нельзя изменить после создания службы. Обязательный.

service

SearchService или IO

Обязательно

Определение создаваемой или обновляемой службы поиска. Тип модели или тип ввода-вывода. Обязательный элемент.

search_management_request_options

SearchManagementRequestOptions

Обязательно

Группа параметров. Значение по умолчанию —Нет.

content_type

str

Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

continuation_token

str

Маркер продолжения для перезапуска опроса из сохраненного состояния.

polling

bool или PollingMethod

По умолчанию методом опроса будет ARMPolling. Передайте значение False для этой операции, чтобы не опрашивать, или передайте собственный инициализированный объект опроса для личной стратегии опроса.

polling_interval

int

Время ожидания по умолчанию между двумя опросами для операций LRO, если нет Retry-After заголовка.

Возвращаемое значение

Экземпляр LROPoller, который возвращает SearchService или результат cls(response)

Возвращаемый тип

LROPoller[SearchService]

Исключения

HttpResponseError

check_name_availability

Проверяет, доступно ли указанное имя службы поиска для использования. служба имена должны быть глобально уникальными, так как они являются частью URI службы (https://<name>.search.windows.net).

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

Параметры

name

str

Обязательно

Имя службы поиска для проверки. служба имена должны содержать только строчные буквы, цифры или тире, не могут использовать тире в качестве первых двух или последних символов, не могут содержать последовательные дефисы и должны иметь длину от 2 до 60 символов. Обязательный.

search_management_request_options

SearchManagementRequestOptions

Обязательно

Группа параметров. Значение по умолчанию —Нет.

type

str

Тип ресурса, имя которого требуется проверить. Это значение всегда должно быть "searchServices". Значение по умолчанию — searchServices. Обратите внимание, что переопределение этого значения по умолчанию может привести к неподдерживаемой реакции.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

CheckNameAvailabilityOutput или результат cls(response)

Возвращаемый тип

CheckNameAvailabilityOutput

Исключения

HttpResponseError

delete

Удаляет службу поиска в указанной группе ресурсов вместе со связанными с ней ресурсами.

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

Параметры

resource_group_name

str

Обязательно

Имя группы ресурсов в текущей подписке. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала. Обязательный элемент.

search_service_name

str

Обязательно

Имя службы Когнитивный поиск Azure, связанной с указанной группой ресурсов. Обязательный.

search_management_request_options

SearchManagementRequestOptions

Обязательно

Группа параметров. Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

None или результат cls(response)

Возвращаемый тип

None

Исключения

HttpResponseError

get

Возвращает службу поиска с заданным именем в заданной группе ресурсов.

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

Параметры

resource_group_name

str

Обязательно

Имя группы ресурсов в текущей подписке. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала. Обязательный.

search_service_name

str

Обязательно

Имя службы Когнитивный поиск Azure, связанной с указанной группой ресурсов. Обязательный элемент.

search_management_request_options

SearchManagementRequestOptions

Обязательно

Группа параметров. Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

SearchService или результат cls(response)

Возвращаемый тип

SearchService

Исключения

HttpResponseError

list_by_resource_group

Возвращает список всех служб поиска в заданной группе ресурсов.

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

Параметры

resource_group_name

str

Обязательно

Имя группы ресурсов в текущей подписке. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала. Обязательный.

search_management_request_options

SearchManagementRequestOptions

Обязательно

Группа параметров. Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

Итератор, например экземпляр SearchService или результат cls(response)

Возвращаемый тип

ItemPaged[SearchService]

Исключения

HttpResponseError

list_by_subscription

Возвращает список всех служб поиска в заданной подписке.

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

Параметры

search_management_request_options

SearchManagementRequestOptions

Обязательно

Группа параметров. Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

Итератор, например экземпляр SearchService или результат cls(response)

Возвращаемый тип

ItemPaged[SearchService]

Исключения

HttpResponseError

update

Обновления существующую службу поиска в указанной группе ресурсов.

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

Параметры

resource_group_name

str

Обязательно

Имя группы ресурсов в текущей подписке. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала. Обязательный.

search_service_name

str

Обязательно

Имя обновляемой службы Когнитивный поиск Azure. Обязательный элемент.

service

SearchServiceUpdate или IO

Обязательно

Определение обновляемой службы поиска. Тип модели или тип ввода-вывода. Обязательный.

search_management_request_options

SearchManagementRequestOptions

Обязательно

Группа параметров. Значение по умолчанию —Нет.

content_type

str

Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

SearchService или результат cls(response)

Возвращаемый тип

SearchService

Исключения

HttpResponseError

Атрибуты

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