# pylint: disable=too-many-lines
# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
from io import IOBase
import sys
from typing import Any, Callable, Dict, IO, Iterable, Iterator, Literal, Optional, TypeVar, Union, cast, overload
import urllib.parse
from azure.core.exceptions import (
ClientAuthenticationError,
HttpResponseError,
ResourceExistsError,
ResourceNotFoundError,
ResourceNotModifiedError,
StreamClosedError,
StreamConsumedError,
map_error,
)
from azure.core.paging import ItemPaged
from azure.core.pipeline import PipelineResponse
from azure.core.polling import LROPoller, NoPolling, PollingMethod
from azure.core.rest import HttpRequest, HttpResponse
from azure.core.tracing.decorator import distributed_trace
from azure.core.utils import case_insensitive_dict
from azure.mgmt.core.exceptions import ARMErrorFormat
from azure.mgmt.core.polling.arm_polling import ARMPolling
from .. import models as _models
from .._serialization import Serializer
if sys.version_info >= (3, 9):
from collections.abc import MutableMapping
else:
from typing import MutableMapping # type: ignore
T = TypeVar("T")
ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]]
_SERIALIZER = Serializer()
_SERIALIZER.client_side_validation = False
def build_create_or_update_request(
resource_group_name: str,
search_service_name: str,
subscription_id: str,
*,
client_request_id: Optional[str] = None,
**kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-02-01-preview"))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"searchServiceName": _SERIALIZER.url("search_service_name", search_service_name, "str"),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if client_request_id is not None:
_headers["x-ms-client-request-id"] = _SERIALIZER.header("client_request_id", client_request_id, "str")
if content_type is not None:
_headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs)
def build_update_request(
resource_group_name: str,
search_service_name: str,
subscription_id: str,
*,
client_request_id: Optional[str] = None,
**kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-02-01-preview"))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"searchServiceName": _SERIALIZER.url("search_service_name", search_service_name, "str"),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if client_request_id is not None:
_headers["x-ms-client-request-id"] = _SERIALIZER.header("client_request_id", client_request_id, "str")
if content_type is not None:
_headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs)
def build_get_request(
resource_group_name: str,
search_service_name: str,
subscription_id: str,
*,
client_request_id: Optional[str] = None,
**kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-02-01-preview"))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"searchServiceName": _SERIALIZER.url(
"search_service_name", search_service_name, "str", pattern=r"^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$"
),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if client_request_id is not None:
_headers["x-ms-client-request-id"] = _SERIALIZER.header("client_request_id", client_request_id, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs)
def build_delete_request(
resource_group_name: str,
search_service_name: str,
subscription_id: str,
*,
client_request_id: Optional[str] = None,
**kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-02-01-preview"))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"searchServiceName": _SERIALIZER.url(
"search_service_name", search_service_name, "str", pattern=r"^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$"
),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if client_request_id is not None:
_headers["x-ms-client-request-id"] = _SERIALIZER.header("client_request_id", client_request_id, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs)
def build_list_by_resource_group_request(
resource_group_name: str, subscription_id: str, *, client_request_id: Optional[str] = None, **kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-02-01-preview"))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if client_request_id is not None:
_headers["x-ms-client-request-id"] = _SERIALIZER.header("client_request_id", client_request_id, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs)
def build_list_by_subscription_request(
subscription_id: str, *, client_request_id: Optional[str] = None, **kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-02-01-preview"))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop("template_url", "/subscriptions/{subscriptionId}/providers/Microsoft.Search/searchServices")
path_format_arguments = {
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if client_request_id is not None:
_headers["x-ms-client-request-id"] = _SERIALIZER.header("client_request_id", client_request_id, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs)
def build_check_name_availability_request(
subscription_id: str, *, client_request_id: Optional[str] = None, **kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-02-01-preview"))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url", "/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability"
)
path_format_arguments = {
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if client_request_id is not None:
_headers["x-ms-client-request-id"] = _SERIALIZER.header("client_request_id", client_request_id, "str")
if content_type is not None:
_headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
def build_upgrade_request(
resource_group_name: str, search_service_name: str, subscription_id: str, **kwargs: Any
) -> HttpRequest:
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-02-01-preview"))
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/upgrade",
) # pylint: disable=line-too-long
path_format_arguments = {
"resourceGroupName": _SERIALIZER.url("resource_group_name", resource_group_name, "str"),
"searchServiceName": _SERIALIZER.url(
"search_service_name", search_service_name, "str", pattern=r"^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$"
),
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
}
_url: str = _url.format(**path_format_arguments) # type: ignore
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
[docs]
class ServicesOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.search.SearchManagementClient`'s
:attr:`services` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
def _create_or_update_initial(
self,
resource_group_name: str,
search_service_name: str,
service: Union[_models.SearchService, IO[bytes]],
search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None,
**kwargs: Any
) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_client_request_id = None
if search_management_request_options is not None:
_client_request_id = search_management_request_options.client_request_id
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(service, (IOBase, bytes)):
_content = service
else:
_json = self._serialize.body(service, "SearchService")
_request = build_create_or_update_request(
resource_group_name=resource_group_name,
search_service_name=search_service_name,
subscription_id=self._config.subscription_id,
client_request_id=_client_request_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 201]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
@overload
def begin_create_or_update(
self,
resource_group_name: str,
search_service_name: str,
service: _models.SearchService,
search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SearchService]:
"""Creates or updates a search service in the given resource group. If the search service already
exists, all properties will be updated with the given values.
.. seealso::
- https://aka.ms/search-manage
:param resource_group_name: The name of the resource group within the current subscription. You
can obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param search_service_name: The name of the Azure AI Search service to create or update. Search
service names must only contain lowercase letters, digits or dashes, cannot use dash as the
first two or last one characters, cannot contain consecutive dashes, and must be between 2 and
60 characters in length. Search service names must be globally unique since they are part of
the service URI (https://\\ :code:`<name>`.search.windows.net). You cannot change the service
name after the service is created. Required.
:type search_service_name: str
:param service: The definition of the search service to create or update. Required.
:type service: ~azure.mgmt.search.models.SearchService
:param search_management_request_options: Parameter group. Default value is None.
:type search_management_request_options:
~azure.mgmt.search.models.SearchManagementRequestOptions
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SearchService or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.search.models.SearchService]
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def begin_create_or_update(
self,
resource_group_name: str,
search_service_name: str,
service: IO[bytes],
search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> LROPoller[_models.SearchService]:
"""Creates or updates a search service in the given resource group. If the search service already
exists, all properties will be updated with the given values.
.. seealso::
- https://aka.ms/search-manage
:param resource_group_name: The name of the resource group within the current subscription. You
can obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param search_service_name: The name of the Azure AI Search service to create or update. Search
service names must only contain lowercase letters, digits or dashes, cannot use dash as the
first two or last one characters, cannot contain consecutive dashes, and must be between 2 and
60 characters in length. Search service names must be globally unique since they are part of
the service URI (https://\\ :code:`<name>`.search.windows.net). You cannot change the service
name after the service is created. Required.
:type search_service_name: str
:param service: The definition of the search service to create or update. Required.
:type service: IO[bytes]
:param search_management_request_options: Parameter group. Default value is None.
:type search_management_request_options:
~azure.mgmt.search.models.SearchManagementRequestOptions
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: An instance of LROPoller that returns either SearchService or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.search.models.SearchService]
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs]
@distributed_trace
def begin_create_or_update(
self,
resource_group_name: str,
search_service_name: str,
service: Union[_models.SearchService, IO[bytes]],
search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None,
**kwargs: Any
) -> LROPoller[_models.SearchService]:
"""Creates or updates a search service in the given resource group. If the search service already
exists, all properties will be updated with the given values.
.. seealso::
- https://aka.ms/search-manage
:param resource_group_name: The name of the resource group within the current subscription. You
can obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param search_service_name: The name of the Azure AI Search service to create or update. Search
service names must only contain lowercase letters, digits or dashes, cannot use dash as the
first two or last one characters, cannot contain consecutive dashes, and must be between 2 and
60 characters in length. Search service names must be globally unique since they are part of
the service URI (https://\\ :code:`<name>`.search.windows.net). You cannot change the service
name after the service is created. Required.
:type search_service_name: str
:param service: The definition of the search service to create or update. Is either a
SearchService type or a IO[bytes] type. Required.
:type service: ~azure.mgmt.search.models.SearchService or IO[bytes]
:param search_management_request_options: Parameter group. Default value is None.
:type search_management_request_options:
~azure.mgmt.search.models.SearchManagementRequestOptions
:return: An instance of LROPoller that returns either SearchService or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.search.models.SearchService]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.SearchService] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._create_or_update_initial(
resource_group_name=resource_group_name,
search_service_name=search_service_name,
service=service,
search_management_request_options=search_management_request_options,
api_version=api_version,
content_type=content_type,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("SearchService", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(PollingMethod, ARMPolling(lro_delay, **kwargs))
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.SearchService].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.SearchService](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)
@overload
def update(
self,
resource_group_name: str,
search_service_name: str,
service: _models.SearchServiceUpdate,
search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.SearchService:
"""Updates an existing search service in the given resource group.
.. seealso::
- https://aka.ms/search-manage
:param resource_group_name: The name of the resource group within the current subscription. You
can obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param search_service_name: The name of the Azure AI Search service to update. Required.
:type search_service_name: str
:param service: The definition of the search service to update. Required.
:type service: ~azure.mgmt.search.models.SearchServiceUpdate
:param search_management_request_options: Parameter group. Default value is None.
:type search_management_request_options:
~azure.mgmt.search.models.SearchManagementRequestOptions
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:return: SearchService or the result of cls(response)
:rtype: ~azure.mgmt.search.models.SearchService
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def update(
self,
resource_group_name: str,
search_service_name: str,
service: IO[bytes],
search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.SearchService:
"""Updates an existing search service in the given resource group.
.. seealso::
- https://aka.ms/search-manage
:param resource_group_name: The name of the resource group within the current subscription. You
can obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param search_service_name: The name of the Azure AI Search service to update. Required.
:type search_service_name: str
:param service: The definition of the search service to update. Required.
:type service: IO[bytes]
:param search_management_request_options: Parameter group. Default value is None.
:type search_management_request_options:
~azure.mgmt.search.models.SearchManagementRequestOptions
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:return: SearchService or the result of cls(response)
:rtype: ~azure.mgmt.search.models.SearchService
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs]
@distributed_trace
def update(
self,
resource_group_name: str,
search_service_name: str,
service: Union[_models.SearchServiceUpdate, IO[bytes]],
search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None,
**kwargs: Any
) -> _models.SearchService:
"""Updates an existing search service in the given resource group.
.. seealso::
- https://aka.ms/search-manage
:param resource_group_name: The name of the resource group within the current subscription. You
can obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param search_service_name: The name of the Azure AI Search service to update. Required.
:type search_service_name: str
:param service: The definition of the search service to update. Is either a SearchServiceUpdate
type or a IO[bytes] type. Required.
:type service: ~azure.mgmt.search.models.SearchServiceUpdate or IO[bytes]
:param search_management_request_options: Parameter group. Default value is None.
:type search_management_request_options:
~azure.mgmt.search.models.SearchManagementRequestOptions
:return: SearchService or the result of cls(response)
:rtype: ~azure.mgmt.search.models.SearchService
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
cls: ClsType[_models.SearchService] = kwargs.pop("cls", None)
_client_request_id = None
if search_management_request_options is not None:
_client_request_id = search_management_request_options.client_request_id
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(service, (IOBase, bytes)):
_content = service
else:
_json = self._serialize.body(service, "SearchServiceUpdate")
_request = build_update_request(
resource_group_name=resource_group_name,
search_service_name=search_service_name,
subscription_id=self._config.subscription_id,
client_request_id=_client_request_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("SearchService", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
[docs]
@distributed_trace
def get(
self,
resource_group_name: str,
search_service_name: str,
search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None,
**kwargs: Any
) -> _models.SearchService:
"""Gets the search service with the given name in the given resource group.
.. seealso::
- https://aka.ms/search-manage
:param resource_group_name: The name of the resource group within the current subscription. You
can obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param search_service_name: The name of the Azure AI Search service associated with the
specified resource group. Required.
:type search_service_name: str
:param search_management_request_options: Parameter group. Default value is None.
:type search_management_request_options:
~azure.mgmt.search.models.SearchManagementRequestOptions
:return: SearchService or the result of cls(response)
:rtype: ~azure.mgmt.search.models.SearchService
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SearchService] = kwargs.pop("cls", None)
_client_request_id = None
if search_management_request_options is not None:
_client_request_id = search_management_request_options.client_request_id
_request = build_get_request(
resource_group_name=resource_group_name,
search_service_name=search_service_name,
subscription_id=self._config.subscription_id,
client_request_id=_client_request_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("SearchService", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
[docs]
@distributed_trace
def delete( # pylint: disable=inconsistent-return-statements
self,
resource_group_name: str,
search_service_name: str,
search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None,
**kwargs: Any
) -> None:
"""Deletes a search service in the given resource group, along with its associated resources.
.. seealso::
- https://aka.ms/search-manage
:param resource_group_name: The name of the resource group within the current subscription. You
can obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param search_service_name: The name of the Azure AI Search service associated with the
specified resource group. Required.
:type search_service_name: str
:param search_management_request_options: Parameter group. Default value is None.
:type search_management_request_options:
~azure.mgmt.search.models.SearchManagementRequestOptions
:return: None or the result of cls(response)
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[None] = kwargs.pop("cls", None)
_client_request_id = None
if search_management_request_options is not None:
_client_request_id = search_management_request_options.client_request_id
_request = build_delete_request(
resource_group_name=resource_group_name,
search_service_name=search_service_name,
subscription_id=self._config.subscription_id,
client_request_id=_client_request_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 204, 404]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
if cls:
return cls(pipeline_response, None, {}) # type: ignore
[docs]
@distributed_trace
def list_by_resource_group(
self,
resource_group_name: str,
search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None,
**kwargs: Any
) -> Iterable["_models.SearchService"]:
"""Gets a list of all Search services in the given resource group.
.. seealso::
- https://aka.ms/search-manage
:param resource_group_name: The name of the resource group within the current subscription. You
can obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param search_management_request_options: Parameter group. Default value is None.
:type search_management_request_options:
~azure.mgmt.search.models.SearchManagementRequestOptions
:return: An iterator like instance of either SearchService or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.search.models.SearchService]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SearchServiceListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_client_request_id = None
if search_management_request_options is not None:
_client_request_id = search_management_request_options.client_request_id
_request = build_list_by_resource_group_request(
resource_group_name=resource_group_name,
subscription_id=self._config.subscription_id,
client_request_id=_client_request_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("SearchServiceListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
[docs]
@distributed_trace
def list_by_subscription(
self, search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None, **kwargs: Any
) -> Iterable["_models.SearchService"]:
"""Gets a list of all Search services in the given subscription.
.. seealso::
- https://aka.ms/search-manage
:param search_management_request_options: Parameter group. Default value is None.
:type search_management_request_options:
~azure.mgmt.search.models.SearchManagementRequestOptions
:return: An iterator like instance of either SearchService or the result of cls(response)
:rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.search.models.SearchService]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SearchServiceListResult] = kwargs.pop("cls", None)
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
def prepare_request(next_link=None):
if not next_link:
_client_request_id = None
if search_management_request_options is not None:
_client_request_id = search_management_request_options.client_request_id
_request = build_list_by_subscription_request(
subscription_id=self._config.subscription_id,
client_request_id=_client_request_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
else:
# make call to next link with the client's api-version
_parsed_next_link = urllib.parse.urlparse(next_link)
_next_request_params = case_insensitive_dict(
{
key: [urllib.parse.quote(v) for v in value]
for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items()
}
)
_next_request_params["api-version"] = self._config.api_version
_request = HttpRequest(
"GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params
)
_request.url = self._client.format_url(_request.url)
_request.method = "GET"
return _request
def extract_data(pipeline_response):
deserialized = self._deserialize("SearchServiceListResult", pipeline_response)
list_of_elem = deserialized.value
if cls:
list_of_elem = cls(list_of_elem) # type: ignore
return deserialized.next_link or None, iter(list_of_elem)
def get_next(next_link=None):
_request = prepare_request(next_link)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
return pipeline_response
return ItemPaged(get_next, extract_data)
[docs]
@distributed_trace
def check_name_availability(
self,
name: str,
search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None,
**kwargs: Any
) -> _models.CheckNameAvailabilityOutput:
"""Checks whether or not the given search service name is available for use. Search service names
must be globally unique since they are part of the service URI (https://\\
:code:`<name>`.search.windows.net).
.. seealso::
- https://aka.ms/search-manage
:param name: The search service name to validate. Search service names must only contain
lowercase letters, digits or dashes, cannot use dash as the first two or last one characters,
cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Required.
:type name: str
:param search_management_request_options: Parameter group. Default value is None.
:type search_management_request_options:
~azure.mgmt.search.models.SearchManagementRequestOptions
:return: CheckNameAvailabilityOutput or the result of cls(response)
:rtype: ~azure.mgmt.search.models.CheckNameAvailabilityOutput
:raises ~azure.core.exceptions.HttpResponseError:
"""
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
content_type: str = kwargs.pop("content_type", _headers.pop("Content-Type", "application/json"))
type: Literal["searchServices"] = kwargs.pop("type", "searchServices")
cls: ClsType[_models.CheckNameAvailabilityOutput] = kwargs.pop("cls", None)
_client_request_id = None
if search_management_request_options is not None:
_client_request_id = search_management_request_options.client_request_id
_check_name_availability_input = _models.CheckNameAvailabilityInput(name=name, type=type)
_json = self._serialize.body(_check_name_availability_input, "CheckNameAvailabilityInput")
_request = build_check_name_availability_request(
subscription_id=self._config.subscription_id,
client_request_id=_client_request_id,
api_version=api_version,
content_type=content_type,
json=_json,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_stream = False
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("CheckNameAvailabilityOutput", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized # type: ignore
def _upgrade_initial(self, resource_group_name: str, search_service_name: str, **kwargs: Any) -> Iterator[bytes]:
error_map: MutableMapping = {
401: ClientAuthenticationError,
404: ResourceNotFoundError,
409: ResourceExistsError,
304: ResourceNotModifiedError,
}
error_map.update(kwargs.pop("error_map", {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None)
_request = build_upgrade_request(
resource_group_name=resource_group_name,
search_service_name=search_service_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
headers=_headers,
params=_params,
)
_request.url = self._client.format_url(_request.url)
_decompress = kwargs.pop("decompress", True)
_stream = True
pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access
_request, stream=_stream, **kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200, 202]:
try:
response.read() # Load the body in memory and close the socket
except (StreamConsumedError, StreamClosedError):
pass
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
response_headers = {}
if response.status_code == 202:
response_headers["Location"] = self._deserialize("str", response.headers.get("Location"))
deserialized = response.stream_download(self._client._pipeline, decompress=_decompress)
if cls:
return cls(pipeline_response, deserialized, response_headers) # type: ignore
return deserialized # type: ignore
[docs]
@distributed_trace
def begin_upgrade(
self, resource_group_name: str, search_service_name: str, **kwargs: Any
) -> LROPoller[_models.SearchService]:
"""Upgrades the Azure AI Search service to the latest version available.
:param resource_group_name: The name of the resource group within the current subscription. You
can obtain this value from the Azure Resource Manager API or the portal. Required.
:type resource_group_name: str
:param search_service_name: The name of the Azure AI Search service associated with the
specified resource group. Required.
:type search_service_name: str
:return: An instance of LROPoller that returns either SearchService or the result of
cls(response)
:rtype: ~azure.core.polling.LROPoller[~azure.mgmt.search.models.SearchService]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version: str = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version))
cls: ClsType[_models.SearchService] = kwargs.pop("cls", None)
polling: Union[bool, PollingMethod] = kwargs.pop("polling", True)
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token: Optional[str] = kwargs.pop("continuation_token", None)
if cont_token is None:
raw_result = self._upgrade_initial(
resource_group_name=resource_group_name,
search_service_name=search_service_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
raw_result.http_response.read() # type: ignore
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("SearchService", pipeline_response.http_response)
if cls:
return cls(pipeline_response, deserialized, {}) # type: ignore
return deserialized
if polling is True:
polling_method: PollingMethod = cast(
PollingMethod, ARMPolling(lro_delay, lro_options={"final-state-via": "location"}, **kwargs)
)
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller[_models.SearchService].from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller[_models.SearchService](
self._client, raw_result, get_long_running_output, polling_method # type: ignore
)