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 skojarzona usługa Azure Key Vault. Klasa Keyvault to uproszczona otoka usługi Azure Key Vault, która umożliwia zarządzanie wpisami tajnymi w magazynie kluczy, w tym ustawienie, pobieranie, usuwanie i wyświetlanie listy wpisów tajnych. Użyj klasy Keyvault, aby bezpiecznie przekazywać wpisy tajne do zdalnych przebiegów 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.

Konstruktor

Keyvault(workspace)

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obszar roboczy usługi Azure Machine Learning skojarzony z tym magazynem kluczy.
workspace Wymagane	Workspace 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 usługi 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 Przebiegu 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 usługi 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łny przykład jest dostępny w witrynie 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 o określonej nazwie.
delete_secrets	Usuń listę wpisów tajnych z usługi Azure Key Vault skojarzonej z obszarem roboczym.
get_secret	Zwraca 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	Zwraca wartości wpisów tajnych dla danej listy nazw wpisów tajnych.
list_secrets	Zwróć listę nazw wpisów tajnych z usługi Azure Key Vault skojarzonej z obszarem roboczym. Ta metoda nie zwraca wartości wpisów tajnych.
set_secret	Dodaj wpis tajny do usługi Azure Key Vault skojarzonej z obszarem roboczym.
set_secrets	Dodaj słownik wpisów tajnych do usługi Azure Key Vault skojarzonej z obszarem roboczym.

delete_secret

Usuń wpis tajny o określonej nazwie.

delete_secret(name)

Parametry

Nazwa	Opis
name Wymagane	str Nazwa wpisu tajnego do usunięcia.

Zwraca

Typ	Opis
None

delete_secrets

Usuń listę wpisów tajnych z usługi Azure Key Vault skojarzonej z obszarem roboczym.

delete_secrets(secrets)

Parametry

Nazwa	Opis
secrets_batch Wymagane	list[str] Lista wpisów tajnych do usunięcia.
secrets Wymagane

Zwraca

Typ	Opis
None

get_secret

Zwraca wartość wpisu tajnego dla danej nazwy wpisu tajnego.

get_secret(name)

Parametry

Nazwa	Opis
name Wymagane	str Nazwa wpisu tajnego zwracająca wartość parametru .

Zwraca

Typ	Opis
str	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	str Nazwa wpisu tajnego zwracającego typ zawartości.

Zwraca

Typ	Opis
str	Typ zawartości wpisu tajnego dla określonej nazwy wpisu tajnego.

get_secrets

Zwraca wartości wpisów tajnych dla danej listy nazw wpisów tajnych.

get_secrets(secrets)

Parametry

Nazwa	Opis
secrets Wymagane	list[str] Lista nazw wpisów tajnych do pobrania wartości.

Zwraca

Typ	Opis
dict(str: str)	Słownik znalezionych i nie odnalezionych wpisów tajnych.

list_secrets

Zwróć listę nazw wpisów tajnych z usługi Azure Key Vault skojarzonej z obszarem roboczym.

Ta metoda nie zwraca wartości wpisów tajnych.

list_secrets()

Zwraca

Typ	Opis
dict(str:str)	Lista słownika nazw wpisów tajnych o formacie {name: "secretName"}

set_secret

Dodaj wpis tajny do usługi Azure Key Vault skojarzonej z obszarem roboczym.

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

Parametry

Nazwa	Opis
name Wymagane	str 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	Domyślna wartość: KeyVaultContentType.not_provided

Zwraca

Typ	Opis
None

set_secrets

Dodaj słownik wpisów tajnych do usługi Azure Key Vault skojarzonej z obszarem roboczym.

set_secrets(secrets_batch)

Parametry

Nazwa	Opis
secrets_batch Wymagane	dict(<xref:str:str>) Słownik nazw wpisów tajnych i wartości do dodania.

Zwraca

Typ	Opis
None