Keyvault Klasse

Verwaltet Geheimnisse in der einem Azure Machine Learning-Arbeitsbereich zugeordneten Azure Key Vault-Instanz.

Jedem Azure Machine Learning-Arbeitsbereich ist eine Ressource namens Azure Key Vault zugeordnet. Die Keyvault-Klasse ist ein vereinfachter Wrapper des Azure Key Vault, mit dem Sie Geheimnisse im Schlüsseltresor verwalten können, einschließlich Festlegen, Abrufen, Löschen und Auflisten von Geheimnissen. Verwenden Sie die Schlüsseltresorklasse, um Geheimnisse sicher an Remoteausführungen zu übergeben, ohne vertrauliche Informationen in Klartext verfügbar zu machen.

Weitere Informationen finden Sie unter Verwenden von Geheimnissen in Trainingsausführungen.

Keyvault-Konstruktor der Klasse.

Vererbung

builtins.object

Keyvault

Konstruktor

Keyvault(workspace)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Azure Machine Learning-Arbeitsbereich, der diesem Schlüsseltresor zugeordnet ist.
workspace Erforderlich	Workspace Der Azure Machine Learning-Arbeitsbereich, der diesem Schlüsseltresor zugeordnet ist.

Hinweise

Bei übermittelten Ausführungen auf lokalen und Remote-Computern können Sie die get_secret-Methode der Ausführungs-Instanz verwenden, um den Geheimniswert des Key Vault abzurufen. Mit der get_secrets-Methode der Ausführungs-Instanz rufen Sie mehrere Geheimnisse ab.

Mit diesen Ausführungs-Methoden erhalten Sie eine einfache Verknüpfung, da die Ausführungs-Instanz ihren Arbeitsbereich und Keyvault kennt und das Geheimnis direkt abrufen kann, ohne den Arbeitsbereich und Schlüsseltresor innerhalb der Remote-Ausführung instanziieren zu müssen.

Das folgende Beispiel zeigt, wie Sie auf den einem Arbeitsbereich zugeordneten Standard-Schlüsseltresor zugreifen und ein Geheimnis festlegen.

   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)

Das vollständige Beispiel finden Sie unter https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb.

Methoden

delete_secret	Das Geheimnis mit dem angegebenen Namen löschen.
delete_secrets	Eine Liste von Geheimnissen aus der Azure Key Vault löschen, die dem Arbeitsbereich zugeordnet ist.
get_secret	Den Geheimniswert für einen bestimmten Geheimnisnamen zurückgeben.
get_secret_content_type	Gibt den Inhaltstyp des Geheimnisses für einen bestimmten Geheimnisnamen zurück.
get_secrets	Die Geheimniswerte für eine bestimmte Liste von Geheimnisnamen zurückgeben.
list_secrets	Eine Liste von Geheimnissen aus der Azure Key Vault zurückgeben, die dem Arbeitsbereich zugeordnet ist. Bei dieser Methode werden die Geheimniswerte nicht zurückgegeben.
set_secret	Dem den Arbeitsbereich zugeordneten Azure Key Vault ein Geheimnis hinzufügen.
set_secrets	Das Wörterbuch mit Geheimnissen dem den Arbeitsbereich zugeordneten Azure Key Vault hinzufügen.

delete_secret

Das Geheimnis mit dem angegebenen Namen löschen.

delete_secret(name)

Parameter

Name	Beschreibung
name Erforderlich	str Der Name des zu löschenden Geheimnisses.

Gibt zurück

Typ	Beschreibung
None

delete_secrets

Eine Liste von Geheimnissen aus der Azure Key Vault löschen, die dem Arbeitsbereich zugeordnet ist.

delete_secrets(secrets)

Parameter

Name	Beschreibung
secrets_batch Erforderlich	list[str] Die Liste der zu löschenden Geheimnisse.
secrets Erforderlich

Gibt zurück

Typ	Beschreibung
None

get_secret

Den Geheimniswert für einen bestimmten Geheimnisnamen zurückgeben.

get_secret(name)

Parameter

Name	Beschreibung
name Erforderlich	str Der Name des Geheimnisses, für den der Wert zurückgeben werden soll.

Gibt zurück

Typ	Beschreibung
str	Der Wert des Geheimnisses für einen angegebenen Geheimnisnamen.

get_secret_content_type

Gibt den Inhaltstyp des Geheimnisses für einen bestimmten Geheimnisnamen zurück.

get_secret_content_type(name)

Parameter

Name	Beschreibung
name Erforderlich	str Der Geheimnisname, für den der Inhaltstyp zurückgegeben werden soll.

Gibt zurück

Typ	Beschreibung
str	Der Geheimnisinhaltstyp für einen angegebenen Geheimnisnamen.

get_secrets

Die Geheimniswerte für eine bestimmte Liste von Geheimnisnamen zurückgeben.

get_secrets(secrets)

Parameter

Name	Beschreibung
secrets Erforderlich	list[str] Die Liste der Geheimnisnamen, für die Werte abgerufen werden.

Gibt zurück

Typ	Beschreibung
dict(str: str)	Ein Wörterbuch mit gefundenen und nicht gefundenen Geheimnissen.

list_secrets

Eine Liste von Geheimnissen aus der Azure Key Vault zurückgeben, die dem Arbeitsbereich zugeordnet ist.

Bei dieser Methode werden die Geheimniswerte nicht zurückgegeben.

list_secrets()

Gibt zurück

Typ	Beschreibung
dict(str:str)	Eine Liste von Wörterbuchs mit Geheimnisnamen im Format {name : "secretName"}

set_secret

Dem den Arbeitsbereich zugeordneten Azure Key Vault ein Geheimnis hinzufügen.

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

Parameter

Name	Beschreibung
name Erforderlich	str Der Name des hinzuzufügenden Geheimnisses.
value Erforderlich	<xref:azureml.core.azureml._restclient.models.KeyVaultContentType> Der Wert des hinzuzufügenden Geheimnisses.
value Erforderlich	Der Inhaltstyp des hinzuzufügenden Geheimnisses.
content_type	Standardwert: KeyVaultContentType.not_provided

Gibt zurück

Typ	Beschreibung
None

set_secrets

Das Wörterbuch mit Geheimnissen dem den Arbeitsbereich zugeordneten Azure Key Vault hinzufügen.

set_secrets(secrets_batch)

Parameter

Name	Beschreibung
secrets_batch Erforderlich	dict(<xref:str:str>) Ein Wörterbuch der hinzuzufügenden Geheimnisnamen und -werte.

Gibt zurück

Typ	Beschreibung
None