Keyvault Класс
Управляет секретами, которые хранятся в Azure Key Vault, связанном с рабочей областью Машинного обучения Azure.
С каждой рабочей областью Машинного обучение Azure связано Azure Key Vault. Класс Keyvault — это упрощенная программа-оболочка Azure Key Vault, которая позволяет управлять секретами в хранилище ключей, в том числе настраивать, извлекать, удалять и перечислять секреты. Используйте класс Keyvault, чтобы безопасно передавать секреты для удаленного выполнения без предоставления конфиденциальной информации в виде открытого текста.
Дополнительные сведения см. в статье Использование секретов в учебных запусках.
Конструктор хранилища ключей класса.
- Наследование
-
builtins.objectKeyvault
Конструктор
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)
Параметры
Возвращаемый тип
delete_secrets
Удаление списка секретов из Azure Key Vault, связанного с рабочей областью.
delete_secrets(secrets)
Параметры
- secrets
Возвращаемый тип
get_secret
Возвращает значение секрета для указанного имени секрета.
get_secret(name)
Параметры
Возвращаемое значение
Значение секрета для указанного имени секрета.
Возвращаемый тип
get_secret_content_type
Возвращает тип содержимого секрета для заданного имени секрета.
get_secret_content_type(name)
Параметры
Возвращаемое значение
Тип содержимого секрета для указанного имени секрета.
Возвращаемый тип
get_secrets
Возвращает значения секретов для заданного списка имен секретов.
get_secrets(secrets)
Параметры
Возвращаемое значение
Словарь найденных и ненайденных секретов.
Возвращаемый тип
list_secrets
Возвращает список имен секретов из Azure Key Vault, связанного с рабочей областью.
Этот метод не возвращает значения секретов.
list_secrets()
Возвращаемое значение
Список словаря с именами секретов в формате {name : "secretName"}
Возвращаемый тип
set_secret
Добавляет секрет в Azure Key Vault, связанный с рабочей областью.
set_secret(name, value, content_type=KeyVaultContentType.not_provided)
Параметры
- value
- <xref:azureml.core.azureml._restclient.models.KeyVaultContentType>
Значение добавляемого секрета.
- value
Тип содержимого добавляемого секрета.
- content_type
Возвращаемый тип
set_secrets
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по