# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import six
[docs]class SearchApiKeyCredential(object):
"""Credential type used for authenticating a SearchIndexClient
with an admin or query API key.
:param api_key: An admin or query key for your Azure Search index.
:type api_key: str
"""
def __init__(self, api_key):
# type: (str) -> None
if not isinstance(api_key, six.string_types):
raise TypeError("api_key must be a string.")
self._api_key = api_key # type: str
@property
def api_key(self):
"""The value of the configured API key.
:rtype: str
"""
# type () -> str
return self._api_key
[docs] def update_key(self, key):
"""Update the API key.
This can be used when you've regenerated your service API key and want
to update long-lived clients.
:param str key: The API key to your Azure search account.
"""
self._api_key = key