Keyvault Třída

Spravuje tajné kódy uložené v Azure Key Vault přidružené k pracovnímu prostoru Azure Machine Learning.

Každý pracovní prostor Azure Machine Learning má přidružený Key Vault Azure. Třída Keyvault je zjednodušená obálka Key Vault Azure, která umožňuje spravovat tajné kódy v trezoru klíčů, včetně nastavení, načítání, odstraňování a výpisu tajných kódů. Pomocí třídy Keyvault můžete bezpečně předávat tajné kódy vzdáleným spuštěním bez zveřejnění citlivých informací ve formátu prostého textu.

Další informace najdete v tématu Použití tajných kódů při trénovacích spuštěních.

Konstruktor Keyvault třídy.

Dědičnost

builtins.object

Keyvault

Konstruktor

Keyvault(workspace)

Parametry

Name	Description
workspace Vyžadováno	Workspace Pracovní prostor Azure Machine Learning přidružený k tomuto trezoru klíčů.
workspace Vyžadováno	Workspace Pracovní prostor Azure Machine Learning přidružený k tomuto trezoru klíčů.

Poznámky

V odeslaných spuštěních na místních a vzdálených výpočetních prostředcích můžete k získání hodnoty tajného klíče z Key Vault použít get_secret metodu instance Run. Pokud chcete získat více tajných kódů, použijte metodu get_secrets instance Run.

Tyto metody Run poskytují jednoduchého zástupce, protože instance Run ví o svém pracovním prostoru a službě KeyVault a může přímo získat tajný kód bez nutnosti vytvořit instanci pracovního prostoru a služby Keyvault v rámci vzdáleného spuštění.

Následující příklad ukazuje přístup k výchozímu trezoru klíčů přidruženému k pracovnímu prostoru a nastavení tajného kódu.

   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)

Úplná ukázka je k dispozici na webu https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb

Metody

delete_secret	Odstraňte tajný kód se zadaným názvem.
delete_secrets	Odstraňte seznam tajných kódů z azure Key Vault přidružených k pracovnímu prostoru.
get_secret	Vrátí hodnotu tajného kódu pro daný název tajného kódu.
get_secret_content_type	Vrátí typ obsahu tajného kódu pro daný název tajného kódu.
get_secrets	Vrátí hodnoty tajných kódů pro daný seznam názvů tajných kódů.
list_secrets	Vrátí seznam názvů tajných kódů ze Key Vault Azure přidružených k pracovnímu prostoru. Tato metoda nevrací tajné hodnoty.
set_secret	Přidejte tajný kód do Key Vault Azure přidružené k pracovnímu prostoru.
set_secrets	Přidejte slovník tajných kódů do Key Vault Azure přidružené k pracovnímu prostoru.

delete_secret

Odstraňte tajný kód se zadaným názvem.

delete_secret(name)

Parametry

Name	Description
name Vyžadováno	str Název tajného kódu, který se má odstranit.

Návraty

Typ	Description
None

delete_secrets

Odstraňte seznam tajných kódů z azure Key Vault přidružených k pracovnímu prostoru.

delete_secrets(secrets)

Parametry

Name	Description
secrets_batch Vyžadováno	list[str] Seznam tajných kódů, které se mají odstranit.
secrets Vyžadováno

Návraty

Typ	Description
None

get_secret

Vrátí hodnotu tajného kódu pro daný název tajného kódu.

get_secret(name)

Parametry

Name	Description
name Vyžadováno	str Název tajného kódu, pro který se má vrátit hodnota.

Návraty

Typ	Description
str	Hodnota tajného kódu pro zadaný název tajného klíče.

get_secret_content_type

Vrátí typ obsahu tajného kódu pro daný název tajného kódu.

get_secret_content_type(name)

Parametry

Name	Description
name Vyžadováno	str Název tajného kódu, pro který se vrátí typ obsahu.

Návraty

Typ	Description
str	Typ obsahu tajného kódu pro zadaný název tajného kódu.

get_secrets

Vrátí hodnoty tajných kódů pro daný seznam názvů tajných kódů.

get_secrets(secrets)

Parametry

Name	Description
secrets Vyžadováno	list[str] Seznam názvů tajných kódů, pro které se mají načíst hodnoty.

Návraty

Typ	Description
dict(str: str)	Slovník nalezených a nenalezených tajných kódů.

list_secrets

Vrátí seznam názvů tajných kódů ze Key Vault Azure přidružených k pracovnímu prostoru.

Tato metoda nevrací tajné hodnoty.

list_secrets()

Návraty

Typ	Description
dict(str:str)	Seznam slovníku názvů tajných kódů ve formátu {name: "secretName"}

set_secret

Přidejte tajný kód do Key Vault Azure přidružené k pracovnímu prostoru.

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

Parametry

Name	Description
name Vyžadováno	str Název tajného kódu, který chcete přidat.
value Vyžadováno	<xref:azureml.core.azureml._restclient.models.KeyVaultContentType> Hodnota tajného kódu, který se má přidat.
value Vyžadováno	Typ obsahu tajného kódu, který chcete přidat.
content_type	Default value: KeyVaultContentType.not_provided

Návraty

Typ	Description
None

set_secrets

Přidejte slovník tajných kódů do Key Vault Azure přidružené k pracovnímu prostoru.

set_secrets(secrets_batch)

Parametry

Name	Description
secrets_batch Vyžadováno	dict(<xref:str:str>) Slovník názvů tajných kódů a hodnot, které se mají přidat.

Návraty

Typ	Description
None