ServicesOperations Class

ServicesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

ServicesOperations

Constructor

ServicesOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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

async begin_create_or_update(resource_group_name: str, search_service_name: str, service: azure.mgmt.search.models._models_py3.SearchService, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.search.models._models_py3.SearchService]

Parameters

resource_group_name

str

Required

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

search_service_name

str

Required

The name of the Azure Cognitive 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://<name>.search.windows.net). You cannot change the service name after the service is created.

service

SearchService

Required

The definition of the search service to create or update.

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either SearchService or the result of cls(response)

Return type

AsyncLROPoller[SearchService]

Exceptions

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).

async check_name_availability(name: str, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> azure.mgmt.search.models._models_py3.CheckNameAvailabilityOutput

Parameters

name

str

Required

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.

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

cls

callable

A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityOutput, or the result of cls(response)

Return type

CheckNameAvailabilityOutput

Exceptions

HttpResponseError

delete

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

async delete(resource_group_name: str, search_service_name: str, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> None

Parameters

resource_group_name

str

Required

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

search_service_name

str

Required

The name of the Azure Cognitive Search service associated with the specified resource group.

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

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

async get(resource_group_name: str, search_service_name: str, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> azure.mgmt.search.models._models_py3.SearchService

Parameters

resource_group_name

str

Required

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

search_service_name

str

Required

The name of the Azure Cognitive Search service associated with the specified resource group.

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

cls

callable

A custom type or function that will be passed the direct response

Returns

SearchService, or the result of cls(response)

Return type

SearchService

Exceptions

HttpResponseError

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: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> AsyncIterable[azure.mgmt.search.models._models_py3.SearchServiceListResult]

Parameters

resource_group_name

str

Required

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SearchServiceListResult or the result of cls(response)

Return type

AsyncItemPaged[SearchServiceListResult]

Exceptions

HttpResponseError

list_by_subscription

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

list_by_subscription(search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> AsyncIterable[azure.mgmt.search.models._models_py3.SearchServiceListResult]

Parameters

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SearchServiceListResult or the result of cls(response)

Return type

AsyncItemPaged[SearchServiceListResult]

Exceptions

HttpResponseError

update

Updates an existing search service in the given resource group.

async update(resource_group_name: str, search_service_name: str, service: azure.mgmt.search.models._models_py3.SearchServiceUpdate, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> azure.mgmt.search.models._models_py3.SearchService

Parameters

resource_group_name

str

Required

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

search_service_name

str

Required

The name of the Azure Cognitive Search service to update.

service

SearchServiceUpdate

Required

The definition of the search service to update.

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

cls

callable

A custom type or function that will be passed the direct response

Returns

SearchService, or the result of cls(response)

Return type

SearchService

Exceptions

HttpResponseError

Attributes

models

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