Keyvault Класс

Управляет секретами, которые хранятся в Azure Key Vault, связанном с рабочей областью Машинного обучения Azure.

С каждой рабочей областью Машинного обучение Azure связано Azure Key Vault. Класс Keyvault — это упрощенная программа-оболочка Azure Key Vault, которая позволяет управлять секретами в хранилище ключей, в том числе настраивать, извлекать, удалять и перечислять секреты. Используйте класс Keyvault, чтобы безопасно передавать секреты для удаленного выполнения без предоставления конфиденциальной информации в виде открытого текста.

Дополнительные сведения см. в статье Использование секретов в учебных запусках.

Конструктор хранилища ключей класса.

Наследование

builtins.object

Keyvault

Конструктор

Keyvault(workspace)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область машинного обучения Azure, связанная с этим хранилищем ключей.
workspace Обязательно	Workspace Рабочая область машинного обучения Azure, связанная с этим хранилищем ключей.

Комментарии

В отправленных выполнениях на локальном и удаленном вычислительном ресурсе можно использовать метод get_secret экземпляра Run, чтобы получить значение секрета из Key Vault. Чтобы получить несколько секретов, используйте метод get_secrets экземпляра Run.

Эти методы Run предоставляют простой ярлык, так как экземпляр Run знает о своей рабочей области и хранилище ключей и может напрямую получить секрет без необходимости создания экземпляра рабочей области и хранилища ключей в удаленном выполнении.

В следующем примере показано, как получить доступ к хранилищу ключей по умолчанию, связанному с рабочей областью, и задать секрет.

   import uuid

   local_secret = os.environ.get("LOCAL_SECRET", default = str(uuid.uuid4())) # Use random UUID as a substitute for real secret.
   keyvault = ws.get_default_keyvault()
   keyvault.set_secret(name="secret-name", value = local_secret)

Полный пример можно найти по адресу: https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb

Методы

delete_secret	Удаление секрета с указанным именем.
delete_secrets	Удаление списка секретов из Azure Key Vault, связанного с рабочей областью.
get_secret	Возвращает значение секрета для указанного имени секрета.
get_secret_content_type	Возвращает тип содержимого секрета для заданного имени секрета.
get_secrets	Возвращает значения секретов для заданного списка имен секретов.
list_secrets	Возвращает список имен секретов из Azure Key Vault, связанного с рабочей областью. Этот метод не возвращает значения секретов.
set_secret	Добавляет секрет в Azure Key Vault, связанный с рабочей областью.
set_secrets	Добавляет словарь секретов в Azure Key Vault, связанное с рабочей областью.

delete_secret

Удаление секрета с указанным именем.

delete_secret(name)

Параметры

Имя	Описание
name Обязательно	str Имя удаляемого секрета.

Возвращаемое значение

Тип	Описание
None

delete_secrets

Удаление списка секретов из Azure Key Vault, связанного с рабочей областью.

delete_secrets(secrets)

Параметры

Имя	Описание
secrets_batch Обязательно	list[str] Список секретов для удаления.
secrets Обязательно

Возвращаемое значение

Тип	Описание
None

get_secret

Возвращает значение секрета для указанного имени секрета.

get_secret(name)

Параметры

Имя	Описание
name Обязательно	str Имя секрета, для которого возвращается значение.

Возвращаемое значение

Тип	Описание
str	Значение секрета для указанного имени секрета.

get_secret_content_type

Возвращает тип содержимого секрета для заданного имени секрета.

get_secret_content_type(name)

Параметры

Имя	Описание
name Обязательно	str Имя секрета, для который возвращается тип контента.

Возвращаемое значение

Тип	Описание
str	Тип содержимого секрета для указанного имени секрета.

get_secrets

Возвращает значения секретов для заданного списка имен секретов.

get_secrets(secrets)

Параметры

Имя	Описание
secrets Обязательно	list[str] Список имен секретов, для которых получаются значения.

Возвращаемое значение

Тип	Описание
dict(str: str)	Словарь найденных и ненайденных секретов.

list_secrets

Возвращает список имен секретов из Azure Key Vault, связанного с рабочей областью.

Этот метод не возвращает значения секретов.

list_secrets()

Возвращаемое значение

Тип	Описание
dict(str:str)	Список словаря с именами секретов в формате {name : "secretName"}

set_secret

Добавляет секрет в Azure Key Vault, связанный с рабочей областью.

set_secret(name, value, content_type=KeyVaultContentType.not_provided)

Параметры

Имя	Описание
name Обязательно	str Имя добавляемого секрета.
value Обязательно	<xref:azureml.core.azureml._restclient.models.KeyVaultContentType> Значение добавляемого секрета.
value Обязательно	Тип содержимого добавляемого секрета.
content_type	Default value: KeyVaultContentType.not_provided

Возвращаемое значение

Тип	Описание
None

set_secrets

Добавляет словарь секретов в Azure Key Vault, связанное с рабочей областью.

set_secrets(secrets_batch)

Параметры

Имя	Описание
secrets_batch Обязательно	dict(<xref:str:str>) Словарь добавляемых имен и значений секретов.

Возвращаемое значение

Тип	Описание
None