Freigeben über

Keyvault Klasse

Verwaltet geheime Schlüssel, die im Azure Key Vault gespeichert sind, der einem Azure Machine Learning-Arbeitsbereich zugeordnet ist.

Jeder Azure Machine Learning-Arbeitsbereich verfügt über einen zugeordneten Azure Key Vault. Die Keyvault-Klasse ist ein vereinfachter Wrapper des Azure Key Vault, mit dem Sie geheime Schlüssel im Schlüsseltresor verwalten können, einschließlich Einstellung, Abrufen, Löschen und Auflisten geheimer Schlüssel. Verwenden Sie die Keyvault-Klasse, um geheime Schlüssel an Remoteausführungen sicher zu übergeben, ohne vertrauliche Informationen im Klartext verfügbar zu machen.

Weitere Informationen finden Sie unter Verwenden von geheimen Schlüsseln in Schulungsläufen.

Class Keyvault-Konstruktor.

Konstruktor

Keyvault(workspace)

Parameter

Name Beschreibung
workspace
Erforderlich
Workspace

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

Der Azure Machine Learning Workspace, der diesem Schlüsseltresor zugeordnet ist.

Hinweise

In übermittelten Ausführungen auf lokaler und Remoteberechnung können Sie die get_secret Methode der Run-Instanz verwenden, um den geheimen Wert aus Key Vault abzurufen. Verwenden Sie die get_secrets Methode der Run-Instanz, um mehrere geheime Schlüssel abzurufen.

Mit diesen Run-Methoden erhalten Sie eine einfache Verknüpfung, da die Run-Instanz den Arbeitsbereich und keyvault kennt und den geheimen Schlüssel direkt abrufen kann, ohne dass der Arbeitsbereich und keyvault innerhalb der Remoteausführung instanziiert werden müssen.

Das folgende Beispiel zeigt, wie Sie auf den Standardschlüsseltresor zugreifen, der einem Arbeitsbereich zugeordnet ist, und einen geheimen Schlüssel 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)

Vollständiges Beispiel ist verfügbar von https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb

Methoden

delete_secret

Löschen Sie den geheimen Schlüssel mit dem angegebenen Namen.
delete_secrets

Löschen Sie eine Liste mit geheimen Schlüsseln aus dem Azure Key Vault, der dem Arbeitsbereich zugeordnet ist.
get_secret

Gibt den geheimen Wert für einen bestimmten geheimen Namen zurück.
get_secret_content_type

Geben Sie den Inhaltstyp des geheimen Schlüssels für einen bestimmten geheimen Namen zurück.
get_secrets

Gibt die geheimen Werte für eine bestimmte Liste geheimer Namen zurück.
list_secrets

Gibt die Liste der geheimen Namen aus dem Azure Key Vault zurück, der dem Arbeitsbereich zugeordnet ist.

Diese Methode gibt die geheimen Werte nicht zurück.
set_secret

Fügen Sie einen geheimen Schlüssel zum Azure Key Vault hinzu, der dem Arbeitsbereich zugeordnet ist.
set_secrets

Fügen Sie das Wörterbuch der geheimen Schlüssel zum Azure Key Vault hinzu, der dem Arbeitsbereich zugeordnet ist.

delete_secret

Löschen Sie den geheimen Schlüssel mit dem angegebenen Namen.

delete_secret(name)

Parameter

Name Beschreibung
name
Erforderlich
str

Der Name des zu löschenden Schlüssels.

Gibt zurück

Typ Beschreibung
None

delete_secrets

Löschen Sie eine Liste mit geheimen Schlüsseln aus dem Azure Key Vault, der dem Arbeitsbereich zugeordnet ist.

delete_secrets(secrets)

Parameter

Name Beschreibung
secrets_batch
Erforderlich
list[str]

Die Liste der zu löschenden geheimen Schlüssel.
secrets
Erforderlich

Gibt zurück

Typ Beschreibung
None

get_secret

Gibt den geheimen Wert für einen bestimmten geheimen Namen zurück.

get_secret(name)

Parameter

Name Beschreibung
name
Erforderlich
str

Der geheime Name, für den der Wert zurückgegeben werden soll.

Gibt zurück

Typ Beschreibung
str

Der geheime Wert für einen angegebenen geheimen Namen.

get_secret_content_type

Geben Sie den Inhaltstyp des geheimen Schlüssels für einen bestimmten geheimen Namen zurück.

get_secret_content_type(name)

Parameter

Name Beschreibung
name
Erforderlich
str

Der geheime Name, für den der Inhaltstyp zurückgegeben werden soll.

Gibt zurück

Typ Beschreibung
str

Der geheime Inhaltstyp für einen angegebenen geheimen Namen.

get_secrets

Gibt die geheimen Werte für eine bestimmte Liste geheimer Namen zurück.

get_secrets(secrets)

Parameter

Name Beschreibung
secrets
Erforderlich
list[str]

Die Liste der geheimen Namen, für die Werte abgerufen werden sollen.

Gibt zurück

Typ Beschreibung
dict(str: str)

Ein Wörterbuch mit gefundenen und nicht gefundenen geheimen Schlüsseln.

list_secrets

Gibt die Liste der geheimen Namen aus dem Azure Key Vault zurück, der dem Arbeitsbereich zugeordnet ist.

Diese Methode gibt die geheimen Werte nicht zurück.

list_secrets()

Gibt zurück

Typ Beschreibung
dict(str:str)

Eine Liste des Wörterbuchs mit geheimen Namen mit dem Format {name : "secretName"}

set_secret

Fügen Sie einen geheimen Schlüssel zum Azure Key Vault hinzu, der dem Arbeitsbereich zugeordnet ist.

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

Parameter

Name Beschreibung
name
Erforderlich
str

Der Name des geheimen Schlüssels, der hinzugefügt werden soll.
value
Erforderlich
<xref:azureml.core.azureml._restclient.models.KeyVaultContentType>

Der Wert des geheimen Schlüssels, der hinzugefügt werden soll.
value
Erforderlich

Der Inhaltstyp des geheimen Schlüssels, der hinzugefügt werden soll.
content_type
Standardwert: KeyVaultContentType.not_provided

Gibt zurück

Typ Beschreibung
None

set_secrets

Fügen Sie das Wörterbuch der geheimen Schlüssel zum Azure Key Vault hinzu, der dem Arbeitsbereich zugeordnet ist.

set_secrets(secrets_batch)

Parameter

Name Beschreibung
secrets_batch
Erforderlich
dict(<xref:str:str>)

Ein Wörterbuch mit geheimen Namen und Werten, die hinzugefügt werden sollen.

Gibt zurück

Typ Beschreibung
None