ServicesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:services> attribute.

Constructor

ServicesOperations(*args, **kwargs)

Methods

begin_create_or_update	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.
begin_upgrade	Upgrades the Azure AI Search service to the latest version available.
check_name_availability	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://`<name>`.search.windows.net).
delete	Deletes a search service in the given resource group, along with its associated resources.
get	Gets the search service with the given name in the given resource group.
list_by_resource_group	Gets a list of all Search services in the given resource group.
list_by_subscription	Gets a list of all Search services in the given subscription.
update	Updates an existing search service in the given resource group.

begin_create_or_update

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.

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]

Parameters

Name	Description
resource_group_name Required	str 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.
search_service_name Required	str 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 unique since they are part of the service URI (https://`<name>`.search.windows.net). You cannot change the service name after the service is created. Required.
service Required	SearchService or IO[bytes] The definition of the search service to create or update. Is either a SearchService type or a IO[bytes] type. Required.
search_management_request_options	SearchManagementRequestOptions Parameter group. Default value is None. Default value: None

Returns

Type	Description
LROPoller[SearchService]	An instance of LROPoller that returns either SearchService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

https://aka.ms/search-manage

begin_upgrade

Upgrades the Azure AI Search service to the latest version available.

begin_upgrade(resource_group_name: str, search_service_name: str, **kwargs: Any) -> LROPoller[SearchService]

Parameters

Name	Description
resource_group_name Required	str 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.
search_service_name Required	str The name of the Azure AI Search service associated with the specified resource group. Required.

Returns

Type	Description
LROPoller[SearchService]	An instance of LROPoller that returns either SearchService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

check_name_availability

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://<name>.search.windows.net).

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

Parameters

Name	Description
name Required	str 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.
search_management_request_options	SearchManagementRequestOptions Parameter group. Default value is None. Default value: None

Returns

Type	Description
CheckNameAvailabilityOutput	CheckNameAvailabilityOutput or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

https://aka.ms/search-manage

delete

Deletes a search service in the given resource group, along with its associated resources.

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

Parameters

Name	Description
resource_group_name Required	str 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.
search_service_name Required	str The name of the Azure AI Search service associated with the specified resource group. Required.
search_management_request_options	SearchManagementRequestOptions Parameter group. Default value is None. Default value: None

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

https://aka.ms/search-manage

get

Gets the search service with the given name in the given resource group.

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

Parameters

Name	Description
resource_group_name Required	str 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.
search_service_name Required	str The name of the Azure AI Search service associated with the specified resource group. Required.
search_management_request_options	SearchManagementRequestOptions Parameter group. Default value is None. Default value: None

Returns

Type	Description
SearchService	SearchService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

https://aka.ms/search-manage

list_by_resource_group

Gets a list of all Search services in the given resource group.

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

Parameters

Name	Description
resource_group_name Required	str 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.
search_management_request_options	SearchManagementRequestOptions Parameter group. Default value is None. Default value: None

Returns

Type	Description
ItemPaged[SearchService]	An iterator like instance of either SearchService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

https://aka.ms/search-manage

list_by_subscription

Gets a list of all Search services in the given subscription.

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

Parameters

Name	Description
search_management_request_options	SearchManagementRequestOptions Parameter group. Default value is None. Default value: None

Returns

Type	Description
ItemPaged[SearchService]	An iterator like instance of either SearchService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

https://aka.ms/search-manage

update

Updates an existing search service in the given resource group.

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

Parameters

Name	Description
resource_group_name Required	str 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.
search_service_name Required	str The name of the Azure AI Search service to update. Required.
service Required	SearchServiceUpdate or IO[bytes] The definition of the search service to update. Is either a SearchServiceUpdate type or a IO[bytes] type. Required.
search_management_request_options	SearchManagementRequestOptions Parameter group. Default value is None. Default value: None

Returns

Type	Description
SearchService	SearchService or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

https://aka.ms/search-manage

Attributes

models

models = <module 'azure.mgmt.search.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv211\\Lib\\site-packages\\azure\\mgmt\\search\\models\\__init__.py'>

Feedback

Was this page helpful?

Share via

ServicesOperations Class

Constructor

Methods

begin_create_or_update

Parameters

Returns

Exceptions

begin_upgrade

Parameters

Returns

Exceptions

check_name_availability

Parameters

Returns

Exceptions

delete

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

list_by_resource_group

Parameters

Returns

Exceptions

list_by_subscription

Parameters

Returns

Exceptions

update

Parameters

Returns

Exceptions

Attributes

models

Feedback