Keyvault Třída

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

Každý pracovní prostor Azure Machine Learning má přidruženou Key Vault Azure. Třída Keyvault je zjednodušená obálka azure Key Vault, 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.

Třída Keyvault konstruktor.

Dědičnost

builtins.object

Keyvault

Konstruktor

Keyvault(workspace)

Parametry

workspace

Workspace

Vyžadováno

Pracovní prostor služby Azure Machine Learning přidružený k tomuto trezoru klíčů.

workspace

Workspace

Vyžadováno

Pracovní prostor služby 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 pomocí get_secret metody instance Run získat hodnotu tajného klíče z Key Vault. Pokud chcete získat více tajných kódů, použijte metodu get_secrets instance Run.

Tyto metody Run vám poskytují jednoduchou zkratku, protože instance Run ví o svém pracovním prostoru a keyvault a může přímo získat tajný klíč 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, jak získat přístup k výchozímu trezoru klíčů přidruženému k pracovnímu prostoru a nastavení tajného klíče.

   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 od 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ý klíč se zadaným názvem.
delete_secrets	Odstraňte seznam tajných kódů z Azure Key Vault přidružené 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 klíče 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	Vraťte seznam názvů tajných kódů z Azure Key Vault přidružené k pracovnímu prostoru. Tato metoda nevrací tajné hodnoty.
set_secret	Přidejte tajný kód do azure Key Vault přidružené k pracovnímu prostoru.
set_secrets	Přidejte slovník tajných kódů do azure Key Vault přidružené k pracovnímu prostoru.

delete_secret

Odstraňte tajný klíč se zadaným názvem.

delete_secret(name)

Parametry

name

str

Vyžadováno

Název tajného kódu, který se má odstranit.

Návratový typ

None

delete_secrets

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

delete_secrets(secrets)

Parametry

secrets_batch

list[str]

Vyžadováno

Seznam tajných kódů, které chcete odstranit.

secrets

Vyžadováno

Návratový typ

None

get_secret

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

get_secret(name)

Parametry

name

str

Vyžadováno

Název tajného kódu, pro který se má vrátit hodnota.

Návraty

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

Návratový typ

str

get_secret_content_type

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

get_secret_content_type(name)

Parametry

name

str

Vyžadováno

Název tajného kódu, pro který se má vrátit typ obsahu.

Návraty

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

Návratový typ

str

get_secrets

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

get_secrets(secrets)

Parametry

secrets

list[str]

Vyžadováno

Seznam názvů tajných kódů, pro které se mají načíst hodnoty.

Návraty

Slovník nalezených a nenalezených tajných kódů.

Návratový typ

dict(<xref:str: str>)

list_secrets

Vraťte seznam názvů tajných kódů z Azure Key Vault přidružené k pracovnímu prostoru.

Tato metoda nevrací tajné hodnoty.

list_secrets()

Návraty

Seznam slovníku názvů tajných kódů ve formátu {name : "secretName"}

Návratový typ

dict(<xref:str:str>)

set_secret

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

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

Parametry

name

str

Vyžadováno

Název tajného kódu, který se má přidat.

value

<xref:azureml.core.azureml._restclient.models.KeyVaultContentType>

Vyžadováno

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

výchozí hodnota: KeyVaultContentType.not_provided

Návratový typ

None

set_secrets

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

set_secrets(secrets_batch)

Parametry

secrets_batch

dict(<xref:str:str>)

Vyžadováno

Slovník názvů tajných kódů a hodnot, které se mají přidat.

Návratový typ

None