Delen via

Keyvault Klas

Beheert geheimen die zijn opgeslagen in de Azure Key Vault die is gekoppeld aan een Azure Machine Learning-werkruimte.

Elke Azure Machine Learning-werkruimte heeft een gekoppelde Azure Key Vault. De Keyvault-klasse is een vereenvoudigde wrapper van De Azure Key Vault waarmee u geheimen in de sleutelkluis kunt beheren, waaronder het instellen, ophalen, verwijderen en weergeven van geheimen. Gebruik de Keyvault-klasse om geheimen veilig door te geven aan externe uitvoeringen zonder gevoelige informatie in duidelijke tekst weer te geven.

Zie Geheimen gebruiken in trainingsuitvoeringen voor meer informatie.

Klasse Keyvault-constructor.

Constructor

Keyvault(workspace)

Parameters

Name Description
workspace
Vereist
Workspace

De Azure Machine Learning-werkruimte die is gekoppeld aan deze sleutelkluis.
workspace
Vereist
Workspace

De Azure Machine Learning-werkruimte die is gekoppeld aan deze sleutelkluis.

Opmerkingen

In ingediende uitvoeringen op lokale en externe berekeningen kunt u de get_secret methode van het run-exemplaar gebruiken om de geheime waarde op te halen uit Key Vault. Als u meerdere geheimen wilt ophalen, gebruikt u de get_secrets methode van het run-exemplaar.

Deze uitvoeringsmethoden bieden u een eenvoudige snelkoppeling omdat het Run-exemplaar op de hoogte is van de werkruimte en keyvault en het geheim rechtstreeks kan verkrijgen zonder dat u de werkruimte en keyvault binnen de externe uitvoering hoeft te instantiëren.

In het volgende voorbeeld ziet u hoe u toegang hebt tot de standaardsleutelkluis die is gekoppeld aan een werkruimte en hoe u een geheim instelt.


   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)

Volledig voorbeeld is beschikbaar vanaf https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb

Methoden

delete_secret

Verwijder het geheim met de opgegeven naam.
delete_secrets

Verwijder een lijst met geheimen uit de Azure Key Vault die is gekoppeld aan de werkruimte.
get_secret

Retourneert de geheime waarde voor een bepaalde geheime naam.
get_secret_content_type

Retourneer het inhoudstype van het geheim voor een bepaalde geheime naam.
get_secrets

Retourneert de geheime waarden voor een bepaalde lijst met geheime namen.
list_secrets

Retourneert de lijst met geheime namen uit de Azure Key Vault die is gekoppeld aan de werkruimte.

Met deze methode worden de geheime waarden niet geretourneerd.
set_secret

Voeg een geheim toe aan de Azure Key Vault die is gekoppeld aan de werkruimte.
set_secrets

Voeg de woordenlijst met geheimen toe aan de Azure Key Vault die is gekoppeld aan de werkruimte.

delete_secret

Verwijder het geheim met de opgegeven naam.

delete_secret(name)

Parameters

Name Description
name
Vereist
str

De naam van het geheim dat u wilt verwijderen.

Retouren

Type Description
None

delete_secrets

Verwijder een lijst met geheimen uit de Azure Key Vault die is gekoppeld aan de werkruimte.

delete_secrets(secrets)

Parameters

Name Description
secrets_batch
Vereist
list[str]

De lijst met geheimen die u wilt verwijderen.
secrets
Vereist

Retouren

Type Description
None

get_secret

Retourneert de geheime waarde voor een bepaalde geheime naam.

get_secret(name)

Parameters

Name Description
name
Vereist
str

De geheime naam waarvoor de waarde moet worden geretourneerd.

Retouren

Type Description
str

De geheime waarde voor een opgegeven geheime naam.

get_secret_content_type

Retourneer het inhoudstype van het geheim voor een bepaalde geheime naam.

get_secret_content_type(name)

Parameters

Name Description
name
Vereist
str

De geheime naam waarvoor het inhoudstype moet worden geretourneerd.

Retouren

Type Description
str

Het geheime inhoudstype voor een opgegeven geheime naam.

get_secrets

Retourneert de geheime waarden voor een bepaalde lijst met geheime namen.

get_secrets(secrets)

Parameters

Name Description
secrets
Vereist
list[str]

De lijst met geheime namen waarvoor waarden moeten worden opgehaald.

Retouren

Type Description
dict(str: str)

Een woordenlijst met gevonden en niet gevonden geheimen.

list_secrets

Retourneert de lijst met geheime namen uit de Azure Key Vault die is gekoppeld aan de werkruimte.

Met deze methode worden de geheime waarden niet geretourneerd.

list_secrets()

Retouren

Type Description
dict(str:str)

Een lijst met geheime namen met de notatie {name: "secretName"}

set_secret

Voeg een geheim toe aan de Azure Key Vault die is gekoppeld aan de werkruimte.

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

Parameters

Name Description
name
Vereist
str

De naam van het geheim dat u wilt toevoegen.
value
Vereist
<xref:azureml.core.azureml._restclient.models.KeyVaultContentType>

De waarde van het geheim dat moet worden toegevoegd.
value
Vereist

Het inhoudstype van het geheim dat moet worden toegevoegd.
content_type
Default value: KeyVaultContentType.not_provided

Retouren

Type Description
None

set_secrets

Voeg de woordenlijst met geheimen toe aan de Azure Key Vault die is gekoppeld aan de werkruimte.

set_secrets(secrets_batch)

Parameters

Name Description
secrets_batch
Vereist
dict(<xref:str:str>)

Een woordenlijst met geheime namen en waarden die moeten worden toegevoegd.

Retouren

Type Description
None