# Microsoft Azure SDK for Python
This is the Microsoft Azure Search Management Client Library.
This package has been tested with Python 3.7+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).
## _Disclaimer_
_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_
## Getting started
### Prerequisites
- Python 3.7+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)
### Install the package
```bash
pip install azure-mgmt-search
pip install azure-identity
```
### Authentication
By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.
- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
- `AZURE_CLIENT_SECRET` for Azure client secret.
In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.
With above configuration, client can be authenticated by following code:
```python
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = SearchManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```
## Examples
Code samples for this package can be found at:
- [Search Search Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
## Troubleshooting
## Next steps
## Provide Feedback
If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project.
# Release History
## 9.1.0 (2023-10-23)
### Features Added
- Added operation group SearchManagementClientOperationsMixin
- Added operation group UsagesOperations
- Model SearchService has a new parameter semantic_search
- Model SearchServiceUpdate has a new parameter semantic_search
## 9.0.0 (2023-02-15)
### Features Added
- Model PrivateEndpointConnectionProperties has a new parameter group_id
- Model PrivateEndpointConnectionProperties has a new parameter provisioning_state
- Model SearchService has a new parameter auth_options
- Model SearchService has a new parameter disable_local_auth
- Model SearchService has a new parameter encryption_with_cmk
- Model SearchServiceUpdate has a new parameter auth_options
- Model SearchServiceUpdate has a new parameter disable_local_auth
- Model SearchServiceUpdate has a new parameter encryption_with_cmk
## 9.0.0b1 (2022-10-28)
### Features Added
- Model Resource has a new parameter identity
- Model Resource has a new parameter location
- Model Resource has a new parameter tags
### Breaking Changes
- Model PrivateLinkResourceProperties no longer has parameter shareable_private_link_resource_types
- Model SearchService no longer has parameter shared_private_link_resources
- Removed operation group SharedPrivateLinkResourcesOperations
## 8.0.0 (2020-12-22)
- GA release
## 8.0.0b1 (2020-10-28)
This is beta preview version.
This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).
**General breaking changes**
- Credential system has been completly revamped:
- `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/
- `credentials` parameter has been renamed `credential`
- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of
supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
- You can't import a `version` module anymore, use `__version__` instead
- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.
- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).
- Most of the operation kwarg have changed. Some of the most noticeable:
- `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user
- For a complete set of
supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
**General new features**
- Type annotations support using `typing`. SDKs are mypy ready.
- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.
- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.
## 3.0.0 (2019-09-28)
**Features**
- Model SearchService has a new parameter shared_private_link_resources
- Model SearchService has a new parameter public_network_access
- Model SearchService has a new parameter private_endpoint_connections
- Model SearchService has a new parameter network_rule_set
- Added operation group PrivateEndpointConnectionsOperations
- Added operation group PrivateLinkResourcesOperations
- Added operation group SharedPrivateLinkResourcesOperations
**Breaking changes**
- Parameter location of model SearchService is now required
- Model Resource no longer has parameter location
- Model Resource no longer has parameter identity
- Model Resource no longer has parameter tags
## 2.1.0 (2019-05-24)
**Features**
- Model SearchService has a new parameter identity
- Model Resource has a new parameter identity
## 2.0.0 (2018-05-21)
**General Breaking changes**
This version uses a next-generation code generator that *might*
introduce breaking changes.
- Model signatures now use only keyword-argument syntax. All
positional arguments must be re-written as keyword-arguments. To
keep auto-completion in most cases, models are now generated for
Python 2 and Python 3. Python 3 uses the "*" syntax for
keyword-only arguments.
- Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
improve the behavior when unrecognized enum values are encountered.
While this is not a breaking change, the distinctions are important,
and are documented here:
<https://docs.python.org/3/library/enum.html#others> At a glance:
- "is" should not be used at all.
- "format" will return the string value, where "%s" string
formatting will return `NameOfEnum.stringvalue`. Format syntax
should be prefered.
- New Long Running Operation:
- Return type changes from
`msrestazure.azure_operation.AzureOperationPoller` to
`msrest.polling.LROPoller`. External API is the same.
- Return type is now **always** a `msrest.polling.LROPoller`,
regardless of the optional parameters used.
- The behavior has changed when using `raw=True`. Instead of
returning the initial call result as `ClientRawResponse`,
without polling, now this returns an LROPoller. After polling,
the final resource will be returned as a `ClientRawResponse`.
- New `polling` parameter. The default behavior is
`Polling=True` which will poll using ARM algorithm. When
`Polling=False`, the response of the initial call will be
returned without polling.
- `polling` parameter accepts instances of subclasses of
`msrest.polling.PollingMethod`.
- `add_done_callback` will no longer raise if called after
polling is finished, but will instead execute the callback right
away.
**Features**
- Add "operations" operation group
- Add services.update
- Client class can be used as a context manager to keep the underlying
HTTP session open for performance
**Bugfixes**
- services.create_or_update is now correctly a Long Running
Operation
- Compatibility of the sdist with wheel 0.31.0
## 1.0.0 (2016-06-23)
This wheel package is now built with the azure wheel extension
## 0.1.0 (2016-08-09)
- Initial Release
Raw data
{
"_id": null,
"home_page": "https://github.com/Azure/azure-sdk-for-python",
"name": "azure-mgmt-search",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "azure,azure sdk",
"author": "Microsoft Corporation",
"author_email": "azpysdkhelp@microsoft.com",
"download_url": "https://files.pythonhosted.org/packages/63/b7/b9431f1ab621f83849f3ace5ba9d2820c731409fce8466b5f06d330d19f4/azure-mgmt-search-9.1.0.tar.gz",
"platform": null,
"description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure Search Management Client Library.\nThis package has been tested with Python 3.7+.\nFor a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).\n\n## _Disclaimer_\n\n_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_\n\n## Getting started\n\n### Prerequisites\n\n- Python 3.7+ is required to use this package.\n- [Azure subscription](https://azure.microsoft.com/free/)\n\n### Install the package\n\n```bash\npip install azure-mgmt-search\npip install azure-identity\n```\n\n### Authentication\n\nBy default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.\n\n- `AZURE_CLIENT_ID` for Azure client ID.\n- `AZURE_TENANT_ID` for Azure tenant ID.\n- `AZURE_CLIENT_SECRET` for Azure client secret.\n\nIn addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.\n\nWith above configuration, client can be authenticated by following code:\n\n```python\nfrom azure.identity import DefaultAzureCredential\nfrom azure.mgmt.search import SearchManagementClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = SearchManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\nCode samples for this package can be found at:\n- [Search Search Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com\n- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)\n\n\n## Troubleshooting\n\n## Next steps\n\n## Provide Feedback\n\nIf you encounter any bugs or have suggestions, please file an issue in the\n[Issues](https://github.com/Azure/azure-sdk-for-python/issues)\nsection of the project. \n\n\n# Release History\n\n## 9.1.0 (2023-10-23)\n\n### Features Added\n\n - Added operation group SearchManagementClientOperationsMixin\n - Added operation group UsagesOperations\n - Model SearchService has a new parameter semantic_search\n - Model SearchServiceUpdate has a new parameter semantic_search\n\n## 9.0.0 (2023-02-15)\n\n### Features Added\n\n - Model PrivateEndpointConnectionProperties has a new parameter group_id\n - Model PrivateEndpointConnectionProperties has a new parameter provisioning_state\n - Model SearchService has a new parameter auth_options\n - Model SearchService has a new parameter disable_local_auth\n - Model SearchService has a new parameter encryption_with_cmk\n - Model SearchServiceUpdate has a new parameter auth_options\n - Model SearchServiceUpdate has a new parameter disable_local_auth\n - Model SearchServiceUpdate has a new parameter encryption_with_cmk\n\n## 9.0.0b1 (2022-10-28)\n\n### Features Added\n\n - Model Resource has a new parameter identity\n - Model Resource has a new parameter location\n - Model Resource has a new parameter tags\n\n### Breaking Changes\n\n - Model PrivateLinkResourceProperties no longer has parameter shareable_private_link_resource_types\n - Model SearchService no longer has parameter shared_private_link_resources\n - Removed operation group SharedPrivateLinkResourcesOperations\n\n## 8.0.0 (2020-12-22)\n\n- GA release\n\n## 8.0.0b1 (2020-10-28)\n\nThis is beta preview version.\n\nThis version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).\n\n**General breaking changes**\n\n- Credential system has been completly revamped:\n\n - `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/\n - `credentials` parameter has been renamed `credential`\n\n- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of\n supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)\n- You can't import a `version` module anymore, use `__version__` instead\n- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.\n- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).\n- Most of the operation kwarg have changed. Some of the most noticeable:\n\n - `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user\n - For a complete set of\n supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)\n\n**General new features**\n\n- Type annotations support using `typing`. SDKs are mypy ready.\n- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.\n- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.\n\n## 3.0.0 (2019-09-28)\n\n**Features**\n\n - Model SearchService has a new parameter shared_private_link_resources\n - Model SearchService has a new parameter public_network_access\n - Model SearchService has a new parameter private_endpoint_connections\n - Model SearchService has a new parameter network_rule_set\n - Added operation group PrivateEndpointConnectionsOperations\n - Added operation group PrivateLinkResourcesOperations\n - Added operation group SharedPrivateLinkResourcesOperations\n\n**Breaking changes**\n\n - Parameter location of model SearchService is now required\n - Model Resource no longer has parameter location\n - Model Resource no longer has parameter identity\n - Model Resource no longer has parameter tags\n\n## 2.1.0 (2019-05-24)\n\n**Features**\n\n - Model SearchService has a new parameter identity\n - Model Resource has a new parameter identity\n\n## 2.0.0 (2018-05-21)\n\n**General Breaking changes**\n\nThis version uses a next-generation code generator that *might*\nintroduce breaking changes.\n\n - Model signatures now use only keyword-argument syntax. All\n positional arguments must be re-written as keyword-arguments. To\n keep auto-completion in most cases, models are now generated for\n Python 2 and Python 3. Python 3 uses the \"*\" syntax for\n keyword-only arguments.\n - Enum types now use the \"str\" mixin (class AzureEnum(str, Enum)) to\n improve the behavior when unrecognized enum values are encountered.\n While this is not a breaking change, the distinctions are important,\n and are documented here:\n <https://docs.python.org/3/library/enum.html#others> At a glance:\n - \"is\" should not be used at all.\n - \"format\" will return the string value, where \"%s\" string\n formatting will return `NameOfEnum.stringvalue`. Format syntax\n should be prefered.\n - New Long Running Operation:\n - Return type changes from\n `msrestazure.azure_operation.AzureOperationPoller` to\n `msrest.polling.LROPoller`. External API is the same.\n - Return type is now **always** a `msrest.polling.LROPoller`,\n regardless of the optional parameters used.\n - The behavior has changed when using `raw=True`. Instead of\n returning the initial call result as `ClientRawResponse`,\n without polling, now this returns an LROPoller. After polling,\n the final resource will be returned as a `ClientRawResponse`.\n - New `polling` parameter. The default behavior is\n `Polling=True` which will poll using ARM algorithm. When\n `Polling=False`, the response of the initial call will be\n returned without polling.\n - `polling` parameter accepts instances of subclasses of\n `msrest.polling.PollingMethod`.\n - `add_done_callback` will no longer raise if called after\n polling is finished, but will instead execute the callback right\n away.\n\n**Features**\n\n - Add \"operations\" operation group\n - Add services.update\n - Client class can be used as a context manager to keep the underlying\n HTTP session open for performance\n\n**Bugfixes**\n\n - services.create_or_update is now correctly a Long Running\n Operation\n - Compatibility of the sdist with wheel 0.31.0\n\n## 1.0.0 (2016-06-23)\n\nThis wheel package is now built with the azure wheel extension\n\n## 0.1.0 (2016-08-09)\n\n - Initial Release\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Microsoft Azure Search Management Client Library for Python",
"version": "9.1.0",
"project_urls": {
"Homepage": "https://github.com/Azure/azure-sdk-for-python"
},
"split_keywords": [
"azure",
"azure sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1b171a8fc321662acffb784914dfd916de842c4e2d6724bd87f7bd9202166f15",
"md5": "77fa13b436715d1712d8606ce7168de6",
"sha256": "488ff81477e980e2b7abf0b857387c74ebbad419e6f6126044e3e6fad2da72b6"
},
"downloads": -1,
"filename": "azure_mgmt_search-9.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "77fa13b436715d1712d8606ce7168de6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 110342,
"upload_time": "2023-10-25T07:53:02",
"upload_time_iso_8601": "2023-10-25T07:53:02.318095Z",
"url": "https://files.pythonhosted.org/packages/1b/17/1a8fc321662acffb784914dfd916de842c4e2d6724bd87f7bd9202166f15/azure_mgmt_search-9.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "63b7b9431f1ab621f83849f3ace5ba9d2820c731409fce8466b5f06d330d19f4",
"md5": "73b968a1e78e2b7d81b1cdbdcc50c485",
"sha256": "53bc6eeadb0974d21f120bb21bb5e6827df6d650e17347460fd83e2d68883599"
},
"downloads": -1,
"filename": "azure-mgmt-search-9.1.0.tar.gz",
"has_sig": false,
"md5_digest": "73b968a1e78e2b7d81b1cdbdcc50c485",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 76258,
"upload_time": "2023-10-25T07:53:00",
"upload_time_iso_8601": "2023-10-25T07:53:00.328389Z",
"url": "https://files.pythonhosted.org/packages/63/b7/b9431f1ab621f83849f3ace5ba9d2820c731409fce8466b5f06d330d19f4/azure-mgmt-search-9.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-25 07:53:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Azure",
"github_project": "azure-sdk-for-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "azure-mgmt-search"
}
JSON
