azure.mgmt.search.operations module

class azure.mgmt.search.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for each request. The current version is 2015-08-19. Constant value: “2015-08-19”.

list(custom_headers=None, raw=False, **operation_config)[source]

Lists all of the available REST API operations of the Microsoft.Search provider.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Operation

Return type

OperationPaged[Operation]

Raises

CloudError

models = <module 'azure.mgmt.search.models' from '/home/vsts/work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/search/models/__init__.py'>
class azure.mgmt.search.operations.AdminKeysOperations(client, config, serializer, deserializer)[source]

Bases: object

AdminKeysOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for each request. The current version is 2015-08-19. Constant value: “2015-08-19”.

get(resource_group_name, search_service_name, search_management_request_options=None, custom_headers=None, raw=False, **operation_config)[source]

Gets the primary and secondary admin API keys for the specified Azure Search service.

Parameters

  • resource_group_name (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.

  • search_service_name (str) – The name of the Azure Search service associated with the specified resource group.

  • search_management_request_options (SearchManagementRequestOptions) – Additional parameters for the operation

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

AdminKeyResult or ClientRawResponse if raw=true

Return type

AdminKeyResult or ClientRawResponse

Raises

CloudError

regenerate(resource_group_name, search_service_name, key_kind, search_management_request_options=None, custom_headers=None, raw=False, **operation_config)[source]

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

Parameters

  • resource_group_name (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.

  • search_service_name (str) – The name of the Azure Search service associated with the specified resource group.

  • key_kind (str or AdminKeyKind) – Specifies which key to regenerate. Valid values include ‘primary’ and ‘secondary’. Possible values include: ‘primary’, ‘secondary’

  • search_management_request_options (SearchManagementRequestOptions) – Additional parameters for the operation

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

AdminKeyResult or ClientRawResponse if raw=true

Return type

AdminKeyResult or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.search.models' from '/home/vsts/work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/search/models/__init__.py'>
class azure.mgmt.search.operations.QueryKeysOperations(client, config, serializer, deserializer)[source]

Bases: object

QueryKeysOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for each request. The current version is 2015-08-19. Constant value: “2015-08-19”.

create(resource_group_name, search_service_name, name, search_management_request_options=None, custom_headers=None, raw=False, **operation_config)[source]

Generates a new query key for the specified Search service. You can create up to 50 query keys per service.

Parameters

  • resource_group_name (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.

  • search_service_name (str) – The name of the Azure Search service associated with the specified resource group.

  • name (str) – The name of the new query API key.

  • search_management_request_options (SearchManagementRequestOptions) – Additional parameters for the operation

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

QueryKey or ClientRawResponse if raw=true

Return type

QueryKey or ClientRawResponse

Raises

CloudError

delete(resource_group_name, search_service_name, key, search_management_request_options=None, custom_headers=None, raw=False, **operation_config)[source]

Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.

Parameters

  • resource_group_name (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.

  • search_service_name (str) – The name of the Azure Search service associated with the specified resource group.

  • key (str) – The query key to be deleted. Query keys are identified by value, not by name.

  • search_management_request_options (SearchManagementRequestOptions) – Additional parameters for the operation

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

list_by_search_service(resource_group_name, search_service_name, search_management_request_options=None, custom_headers=None, raw=False, **operation_config)[source]

Returns the list of query API keys for the given Azure Search service.

Parameters

  • resource_group_name (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.

  • search_service_name (str) – The name of the Azure Search service associated with the specified resource group.

  • search_management_request_options (SearchManagementRequestOptions) – Additional parameters for the operation

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of QueryKey

Return type

QueryKeyPaged[QueryKey]

Raises

CloudError

models = <module 'azure.mgmt.search.models' from '/home/vsts/work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/search/models/__init__.py'>
class azure.mgmt.search.operations.ServicesOperations(client, config, serializer, deserializer)[source]

Bases: object

ServicesOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for each request. The current version is 2015-08-19. Constant value: “2015-08-19”.

check_name_availability(name, search_management_request_options=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • name (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.

  • search_management_request_options (SearchManagementRequestOptions) – Additional parameters for the operation

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

CheckNameAvailabilityOutput or ClientRawResponse if raw=true

Return type

CheckNameAvailabilityOutput or ClientRawResponse

Raises

CloudError

create_or_update(resource_group_name, search_service_name, service, search_management_request_options=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

Parameters

  • resource_group_name (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.

  • search_service_name (str) – The name of the Azure 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) – The definition of the Search service to create or update.

  • search_management_request_options (SearchManagementRequestOptions) – Additional parameters for the operation

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

An instance of LROPoller that returns SearchService or ClientRawResponse<SearchService> if raw==True

Return type

AzureOperationPoller[SearchService] or AzureOperationPoller[ClientRawResponse[SearchService]]

Raises

CloudError

delete(resource_group_name, search_service_name, search_management_request_options=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • resource_group_name (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.

  • search_service_name (str) – The name of the Azure Search service associated with the specified resource group.

  • search_management_request_options (SearchManagementRequestOptions) – Additional parameters for the operation

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, search_service_name, search_management_request_options=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • resource_group_name (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.

  • search_service_name (str) – The name of the Azure Search service associated with the specified resource group.

  • search_management_request_options (SearchManagementRequestOptions) – Additional parameters for the operation

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

SearchService or ClientRawResponse if raw=true

Return type

SearchService or ClientRawResponse

Raises

CloudError

list_by_resource_group(resource_group_name, search_management_request_options=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • resource_group_name (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.

  • search_management_request_options (SearchManagementRequestOptions) – Additional parameters for the operation

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of SearchService

Return type

SearchServicePaged[SearchService]

Raises

CloudError

list_by_subscription(search_management_request_options=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • search_management_request_options (SearchManagementRequestOptions) – Additional parameters for the operation

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of SearchService

Return type

SearchServicePaged[SearchService]

Raises

CloudError

update(resource_group_name, search_service_name, service, search_management_request_options=None, custom_headers=None, raw=False, **operation_config)[source]

Updates an existing Search service in the given resource group.

Parameters

  • resource_group_name (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.

  • search_service_name (str) – The name of the Azure Search service to update.

  • service (SearchService) – The definition of the Search service to update.

  • search_management_request_options (SearchManagementRequestOptions) – Additional parameters for the operation

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

SearchService or ClientRawResponse if raw=true

Return type

SearchService or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.search.models' from '/home/vsts/work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/search/models/__init__.py'>