Keyvault Klasa
Zarządza wpisami tajnymi przechowywanymi w usłudze Azure Key Vault skojarzonym z obszarem roboczym usługi Azure Machine Learning.
Każdy obszar roboczy usługi Azure Machine Learning ma skojarzone Key Vault platformy Azure. Klasa Keyvault to uproszczona otoka usługi Azure Key Vault, która umożliwia zarządzanie wpisami tajnymi w magazynie kluczy, w tym ustawianie, pobieranie, usuwanie i wyświetlanie wpisów tajnych. Użyj klasy Keyvault, aby bezpiecznie przekazywać wpisy tajne do przebiegów zdalnych bez ujawniania poufnych informacji w postaci zwykłego tekstu.
Aby uzyskać więcej informacji, zobacz Używanie wpisów tajnych w przebiegach trenowania.
Konstruktor klasy Keyvault.
- Dziedziczenie
-
builtins.objectKeyvault
Konstruktor
Keyvault(workspace)
Parametry
Nazwa | Opis |
---|---|
workspace
Wymagane
|
Obszar roboczy usługi Azure Machine Learning skojarzony z tym magazynem kluczy. |
workspace
Wymagane
|
Obszar roboczy usługi Azure Machine Learning skojarzony z tym magazynem kluczy. |
Uwagi
W przypadku przesłanych przebiegów w środowisku lokalnym i zdalnym obliczeniowym można użyć get_secret metody wystąpienia Uruchom, aby uzyskać wartość wpisu tajnego z Key Vault. Aby uzyskać wiele wpisów tajnych, użyj get_secrets metody wystąpienia Uruchom.
Te metody uruchamiania udostępnia prosty skrót, ponieważ wystąpienie Uruchom jest świadome jego obszaru roboczego i usługi Keyvault i może bezpośrednio uzyskać wpis tajny bez konieczności tworzenia wystąpienia obszaru roboczego i funkcji Keyvault w ramach zdalnego uruchamiania.
W poniższym przykładzie pokazano, jak uzyskać dostęp do domyślnego magazynu kluczy skojarzonego z obszarem roboczym i ustawić wpis tajny.
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)
Pełna próbka jest dostępna z witryny https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb
Metody
delete_secret |
Usuń wpis tajny z określoną nazwą. |
delete_secrets |
Usuń listę wpisów tajnych z witryny Azure Key Vault skojarzonej z obszarem roboczym. |
get_secret |
Zwróć wartość wpisu tajnego dla danej nazwy wpisu tajnego. |
get_secret_content_type |
Zwróć typ zawartości wpisu tajnego dla danej nazwy wpisu tajnego. |
get_secrets |
Zwróć wartości wpisów tajnych dla danej listy nazw wpisów tajnych. |
list_secrets |
Zwróć listę nazw wpisów tajnych z witryny Azure Key Vault skojarzonej z obszarem roboczym. Ta metoda nie zwraca wartości wpisów tajnych. |
set_secret |
Dodaj wpis tajny do Key Vault platformy Azure skojarzony z obszarem roboczym. |
set_secrets |
Dodaj słownik wpisów tajnych do Key Vault platformy Azure skojarzonego z obszarem roboczym. |
delete_secret
Usuń wpis tajny z określoną nazwą.
delete_secret(name)
Parametry
Nazwa | Opis |
---|---|
name
Wymagane
|
Nazwa wpisu tajnego do usunięcia. |
Zwraca
Typ | Opis |
---|---|
delete_secrets
Usuń listę wpisów tajnych z witryny Azure Key Vault skojarzonej z obszarem roboczym.
delete_secrets(secrets)
Parametry
Nazwa | Opis |
---|---|
secrets_batch
Wymagane
|
Lista wpisów tajnych do usunięcia. |
secrets
Wymagane
|
|
Zwraca
Typ | Opis |
---|---|
get_secret
Zwróć wartość wpisu tajnego dla danej nazwy wpisu tajnego.
get_secret(name)
Parametry
Nazwa | Opis |
---|---|
name
Wymagane
|
Nazwa wpisu tajnego, dla których ma być zwracana wartość. |
Zwraca
Typ | Opis |
---|---|
Wartość wpisu tajnego dla określonej nazwy wpisu tajnego. |
get_secret_content_type
Zwróć typ zawartości wpisu tajnego dla danej nazwy wpisu tajnego.
get_secret_content_type(name)
Parametry
Nazwa | Opis |
---|---|
name
Wymagane
|
Nazwa wpisu tajnego, dla których ma być zwracany typ zawartości. |
Zwraca
Typ | Opis |
---|---|
Typ zawartości wpisu tajnego dla określonej nazwy wpisu tajnego. |
get_secrets
Zwróć wartości wpisów tajnych dla danej listy nazw wpisów tajnych.
get_secrets(secrets)
Parametry
Nazwa | Opis |
---|---|
secrets
Wymagane
|
Lista nazw wpisów tajnych do pobrania wartości. |
Zwraca
Typ | Opis |
---|---|
Słownik znalezionych i nie znaleziono wpisów tajnych. |
list_secrets
Zwróć listę nazw wpisów tajnych z witryny Azure Key Vault skojarzonej z obszarem roboczym.
Ta metoda nie zwraca wartości wpisów tajnych.
list_secrets()
Zwraca
Typ | Opis |
---|---|
Lista słownika nazw wpisów tajnych o formacie {name: "secretName"} |
set_secret
Dodaj wpis tajny do Key Vault platformy Azure skojarzony z obszarem roboczym.
set_secret(name, value, content_type=KeyVaultContentType.not_provided)
Parametry
Nazwa | Opis |
---|---|
name
Wymagane
|
Nazwa wpisu tajnego do dodania. |
value
Wymagane
|
<xref:azureml.core.azureml._restclient.models.KeyVaultContentType>
Wartość wpisu tajnego do dodania. |
value
Wymagane
|
Typ zawartości wpisu tajnego do dodania. |
content_type
|
wartość domyślna: KeyVaultContentType.not_provided
|
Zwraca
Typ | Opis |
---|---|
set_secrets
Opinia
https://aka.ms/ContentUserFeedback.
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź:Prześlij i wyświetl opinię dla