Dela via

Keyvault Klass

Hanterar hemligheter som lagras i Azure Key Vault som är associerade med en Azure Machine Learning-arbetsyta.

Varje Azure Machine Learning-arbetsyta har ett associerat Azure Key Vault. Klassen Keyvault är en förenklad omslutning av Azure Key Vault som gör att du kan hantera hemligheter i nyckelvalvet, inklusive inställning, hämtning, borttagning och listning av hemligheter. Använd Klassen Keyvault för att skicka hemligheter till fjärrkörningar på ett säkert sätt utan att exponera känslig information i klartext.

Mer information finns i Använda hemligheter i träningskörningar.

Class Keyvault-konstruktor.

Konstruktor

Keyvault(workspace)

Parametrar

Name Description
workspace
Obligatorisk
Workspace

Azure Machine Learning-arbetsytan som är associerad med det här nyckelvalvet.
workspace
Obligatorisk
Workspace

Azure Machine Learning-arbetsytan som är associerad med det här nyckelvalvet.

Kommentarer

I skickade körningar på lokal och fjärrberäkning kan du använda get_secret metoden för Kör-instansen för att hämta det hemliga värdet från Key Vault. Om du vill hämta flera hemligheter använder du get_secrets metoden för Run-instansen.

De här körningsmetoderna ger dig en enkel genväg eftersom Run-instansen är medveten om dess arbetsyta och Keyvault och kan hämta hemligheten direkt utan att behöva instansiera arbetsytan och nyckelvalvet i fjärrkörningen.

I följande exempel visas hur du kommer åt standardnyckelvalvet som är associerat med en arbetsyta och anger en hemlighet.


   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)

Fullständigt exempel är tillgängligt från https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb

Metoder

delete_secret

Ta bort hemligheten med det angivna namnet.
delete_secrets

Ta bort en lista med hemligheter från Azure Key Vault som är associerad med arbetsytan.
get_secret

Returnera det hemliga värdet för ett visst hemligt namn.
get_secret_content_type

Returnera hemlighetens innehållstyp för ett visst hemligt namn.
get_secrets

Returnera de hemliga värdena för en viss lista med hemliga namn.
list_secrets

Returnera listan med hemliga namn från Azure Key Vault som är associerad med arbetsytan.

Den här metoden returnerar inte de hemliga värdena.
set_secret

Lägg till en hemlighet i Azure Key Vault som är associerat med arbetsytan.
set_secrets

Lägg till ordlistan med hemligheter i Azure Key Vault som är associerad med arbetsytan.

delete_secret

Ta bort hemligheten med det angivna namnet.

delete_secret(name)

Parametrar

Name Description
name
Obligatorisk
str

Namnet på hemligheten som ska tas bort.

Returer

Typ Description
None

delete_secrets

Ta bort en lista med hemligheter från Azure Key Vault som är associerad med arbetsytan.

delete_secrets(secrets)

Parametrar

Name Description
secrets_batch
Obligatorisk
list[str]

Listan över hemligheter som ska tas bort.
secrets
Obligatorisk

Returer

Typ Description
None

get_secret

Returnera det hemliga värdet för ett visst hemligt namn.

get_secret(name)

Parametrar

Name Description
name
Obligatorisk
str

Det hemliga namn som värdet ska returneras för.

Returer

Typ Description
str

Det hemliga värdet för ett angivet hemligt namn.

get_secret_content_type

Returnera hemlighetens innehållstyp för ett visst hemligt namn.

get_secret_content_type(name)

Parametrar

Name Description
name
Obligatorisk
str

Det hemliga namn som innehållstypen ska returneras för.

Returer

Typ Description
str

Den hemliga innehållstypen för ett angivet hemligt namn.

get_secrets

Returnera de hemliga värdena för en viss lista med hemliga namn.

get_secrets(secrets)

Parametrar

Name Description
secrets
Obligatorisk
list[str]

Listan med hemliga namn att hämta värden för.

Returer

Typ Description
dict(str: str)

En ordlista med hittade och hittade inte hemligheter.

list_secrets

Returnera listan med hemliga namn från Azure Key Vault som är associerad med arbetsytan.

Den här metoden returnerar inte de hemliga värdena.

list_secrets()

Returer

Typ Description
dict(str:str)

En lista över ordlistor med hemliga namn med formatet {name : "secretName"}

set_secret

Lägg till en hemlighet i Azure Key Vault som är associerat med arbetsytan.

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

Parametrar

Name Description
name
Obligatorisk
str

Namnet på hemligheten som ska läggas till.
value
Obligatorisk
<xref:azureml.core.azureml._restclient.models.KeyVaultContentType>

Värdet för hemligheten som ska läggas till.
value
Obligatorisk

Innehållstypen för hemligheten som ska läggas till.
content_type
Standardvärde: KeyVaultContentType.not_provided

Returer

Typ Description
None

set_secrets

Lägg till ordlistan med hemligheter i Azure Key Vault som är associerad med arbetsytan.

set_secrets(secrets_batch)

Parametrar

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

En ordlista med hemliga namn och värden att lägga till.

Returer

Typ Description
None