Keyvault 類別

  • 參考

管理與 Azure Machine Learning 工作區相關聯的 Azure 金鑰保存庫中所儲存的秘密。

每個 Azure Machine Learning 工作區都有相關聯的Azure 金鑰保存庫。 Keyvault 類別是 Azure 金鑰保存庫的簡化包裝函式，可讓您管理金鑰保存庫中的秘密，包括設定、擷取、刪除和列出秘密。 使用 Keyvault 類別安全地將秘密傳遞至遠端執行，而不需以純文字公開敏感性資訊。

如需詳細資訊，請參閱 在定型回合中使用秘密。

類別 Keyvault 建構函式。

繼承
builtins.object
Keyvault

建構函式

Keyvault(workspace)

參數

workspace
Workspace
必要

與此金鑰保存庫相關聯的 Azure Machine Learning 工作區。

workspace
Workspace
必要

與此金鑰保存庫相關聯的 Azure Machine Learning 工作區。

備註

在本機和遠端計算上提交的執行中，您可以使用 get_secret Run 實例的 方法來從金鑰保存庫取得秘密值。 若要取得多個秘密，請使用 get_secrets Run 實例的 方法。

這些 Run 方法提供簡單的快捷方式，因為 Run 實例知道其 Workspace 和 Keyvault，而且可以直接取得秘密，而不需要在遠端執行內具現化 Workspace 和 Keyvault。

下列範例示範如何存取與工作區相關聯的預設金鑰保存庫，並設定秘密。


   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)

完整範例可從 https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb

方法

delete_secret

刪除具有指定名稱的秘密。
delete_secrets

從與工作區相關聯的 Azure 金鑰保存庫中刪除秘密清單。
get_secret

傳回指定秘密名稱的秘密值。
get_secret_content_type

傳回指定秘密名稱的秘密內容類型。
get_secrets

傳回指定秘密名稱清單的秘密值。
list_secrets

從與工作區相關聯的 Azure 金鑰保存庫傳回秘密名稱清單。

這個方法不會傳回秘密值。
set_secret

將秘密新增至與工作區相關聯的 Azure 金鑰保存庫。
set_secrets

將秘密字典新增至與工作區相關聯的 Azure 金鑰保存庫。

delete_secret

刪除具有指定名稱的秘密。

delete_secret(name)

參數

name
str
必要

要刪除的秘密名稱。

傳回類型

None

delete_secrets

從與工作區相關聯的 Azure 金鑰保存庫中刪除秘密清單。

delete_secrets(secrets)

參數

secrets_batch
list[str]
必要

要刪除的秘密清單。

secrets
必要

傳回類型

None

get_secret

傳回指定秘密名稱的秘密值。

get_secret(name)

參數

name
str
必要

要傳回值的秘密名稱。

傳回

指定秘密名稱的秘密值。

傳回類型

str

get_secret_content_type

傳回指定秘密名稱的秘密內容類型。

get_secret_content_type(name)

參數

name
str
必要

要傳回內容類型的秘密名稱。

傳回

指定秘密名稱的秘密內容類型。

傳回類型

str

get_secrets

傳回指定秘密名稱清單的秘密值。

get_secrets(secrets)

參數

secrets
list[str]
必要

要擷取值的秘密名稱清單。

傳回

找到且找不到秘密的字典。

傳回類型

dict(<xref:str: str>)

list_secrets

從與工作區相關聯的 Azure 金鑰保存庫傳回秘密名稱清單。

這個方法不會傳回秘密值。

list_secrets()

傳回

密碼名稱格式為 {name ： 「secretName」} 的字典清單

傳回類型

dict(<xref:str:str>)

set_secret

將秘密新增至與工作區相關聯的 Azure 金鑰保存庫。

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

參數

name
str
必要

要加入的秘密名稱。

value
<xref:azureml.core.azureml._restclient.models.KeyVaultContentType>
必要

要加入的秘密值。

value
必要

要新增之秘密的內容類型。

content_type
預設值: KeyVaultContentType.not_provided

傳回類型

None

set_secrets

將秘密字典新增至與工作區相關聯的 Azure 金鑰保存庫。

set_secrets(secrets_batch)

參數

secrets_batch
dict(<xref:str:str>)
必要

要加入之秘密名稱和值的字典。

傳回類型

None