Keyvault Kelas

Mengelola rahasia yang disimpan di Azure Key Vault yang terkait dengan ruang kerja Azure Machine Learning.

Setiap ruang kerja Azure Machine Learning memiliki Azure Key Vault terkait. Kelas Keyvault adalah wrapper Azure Key Vault yang disederhanakan yang memungkinkan Anda mengelola rahasia di brankas kunci termasuk pengaturan, pengambilan, penghapusan, dan daftar rahasia. Gunakan kelas Keyvault untuk meneruskan rahasia ke eksekusi jarak jauh dengan aman tanpa mengekspos informasi sensitif dalam teksbersih.

Untuk informasi selengkapnya, lihat Menggunakan rahasia dalam eksekusi pelatihan.

Warisan

builtins.object

Keyvault

Konstruktor

Keyvault(workspace)

Parameter

workspace

Workspace

Diperlukan

Ruang Kerja Azure Machine Learning yang terkait dengan brankas kunci ini.

Keterangan

Dalam eksekusi yang dikirimkan pada komputasi lokal dan jarak jauh, Anda dapat menggunakan metode get_secret dari instans Eksekusi untuk mendapatkan nilai rahasia dari Key Vault. Untuk mendapatkan beberapa rahasia, gunakan metode get_secrets instans Eksekusi.

Metode Eksekusi ini memberi Anda pintasan sederhana karena instans Eksekusi mengetahui Ruang kerja dan Keyvault-nya, dan bisa langsung mendapatkan rahasianya tanpa perlu membuat instans Ruang kerja dan Keyvault dalam eksekusi jarak jauh.

Contoh berikut menunjukkan cara mengakses brankas kunci default yang terkait dengan ruang kerja dan mengatur rahasia.

   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)

Sampel lengkap tersedia dari https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb

Metode

delete_secret	Hapus rahasia dengan nama yang ditentukan.
delete_secrets	Hapus daftar rahasia dari Azure Key Vault yang terkait dengan ruang kerja.
get_secret	Kembalikan nilai rahasia untuk nama rahasia yang diberikan.
get_secret_content_type	Mengembalikan jenis konten rahasia untuk nama rahasia tertentu.
get_secrets	Kembalikan nilai rahasia untuk daftar nama rahasia yang diberikan.
list_secrets	Kembalikan daftar nama rahasia dari Azure Key Vault yang terkait dengan ruang kerja. Metode ini tidak mengembalikan nilai rahasia.
set_secret	Tambahkan rahasia ke Azure Key Vault yang terkait dengan ruang kerja.
set_secrets	Tambahkan kamus rahasia ke Azure Key Vault yang terkait dengan ruang kerja.

delete_secret

Hapus rahasia dengan nama yang ditentukan.

delete_secret(name)

Parameter

name

str

Diperlukan

Nama rahasia yang akan dihapus.

Tipe hasil

None

delete_secrets

Hapus daftar rahasia dari Azure Key Vault yang terkait dengan ruang kerja.

delete_secrets(secrets)

Parameter

secrets_batch

list[str]

Diperlukan

Daftar rahasia yang akan dihapus.

Tipe hasil

None

get_secret

Kembalikan nilai rahasia untuk nama rahasia yang diberikan.

get_secret(name)

Parameter

name

str

Diperlukan

Nama rahasia yang nilainya dikembalikan.

Mengembalikan

Nilai rahasia untuk nama rahasia yang ditentukan.

Tipe hasil

str

get_secret_content_type

Mengembalikan jenis konten rahasia untuk nama rahasia tertentu.

get_secret_content_type(name)

Parameter

name

str

Diperlukan

Nama rahasia untuk mengembalikan tipe konten.

Mengembalikan

Jenis konten rahasia untuk nama rahasia tertentu.

Tipe hasil

str

get_secrets

Kembalikan nilai rahasia untuk daftar nama rahasia yang diberikan.

get_secrets(secrets)

Parameter

secrets

list[str]

Diperlukan

Daftar nama rahasia yang nilainya diambil.

Mengembalikan

Kamus berisi rahasia yang ditemukan dan tidak.

Tipe hasil

dict(<xref:str: str>)

list_secrets

Kembalikan daftar nama rahasia dari Azure Key Vault yang terkait dengan ruang kerja.

Metode ini tidak mengembalikan nilai rahasia.

list_secrets()

Mengembalikan

Daftar kamus nama rahasia dengan format {nama : "secretName"}

Tipe hasil

dict(<xref:str:str>)

set_secret

Tambahkan rahasia ke Azure Key Vault yang terkait dengan ruang kerja.

set_secret(name, value, content_type=<KeyVaultContentType.not_provided: 'application/NotProvided'>)

Parameter

name

str

Diperlukan

Nama rahasia yang akan ditambahkan.

value

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

Diperlukan

Nilai rahasia yang akan ditambahkan.

value

nilai default: KeyVaultContentType.not_provided

Jenis konten rahasia yang akan ditambahkan.

Tipe hasil

None

set_secrets

Tambahkan kamus rahasia ke Azure Key Vault yang terkait dengan ruang kerja.

set_secrets(secrets_batch)

Parameter

secrets_batch

dict(<xref:str:str>)

Diperlukan

Kamus nama dan nilai rahasia yang akan ditambahkan.

Tipe hasil

None