Keyvault クラス

  • リファレンス

Azure Machine Learning ワークスペースに関連付けられた Azure Key Vault に保存されているシークレットを管理します。

各 Azure Machine Learning ワークスペースに、Azure Key Vaultが関連付けられています。 Keyvault クラスは、Azure Key Vault のシンプルなラッパーです。これにより、シークレットの設定、取得、削除、一覧表示など、キーコンテナー内のシークレットを管理できます。 Keyvault クラスを使用して、機密情報をクリア テキストで公開することなく、シークレットをリモート実行に安全に渡します。

詳細については、トレーニングの実行でのシークレットの使用に関する記事をご覧ください。

クラス Keyvault コンストラクター。

継承
builtins.object
Keyvault

コンストラクター

Keyvault(workspace)

パラメーター

workspace
Workspace
必須

このキー コンテナーに関連付けられている Azure Machine Learning ワークスペース。

workspace
Workspace
必須

このキー コンテナーに関連付けられている Azure Machine Learning ワークスペース。

注釈

ローカルとリモートのコンピューティング上で送信された実行では、Run インスタンスのget_secretメソッドを使用して、Key Vault からシークレット値を取得できます。 複数のシークレットを取得するには、Run インスタンスのget_secretsメソッドを使用します。

Run インスタンスはそのワークスペースと Keyvault を認識しており、リモート実行内で Workspace と Keyvault をインスタンス化しなくてもシークレットを直接取得できるため、これらの Run メソッドは簡単なショートカットになります。

次の例は、ワークスペースに関連付けられている既定のキー コンテナーにアクセスして、シークレットを設定する方法を示しています。


   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 Key Vault からシークレットのリストを削除します。
get_secret

指定されたシークレット名のシークレット値を返します。
get_secret_content_type

指定されたシークレット名のシークレットのコンテンツ タイプを返します。
get_secrets

指定されたシークレット名のリストに対するシークレット値を返します。
list_secrets

ワークスペースに関連付けられている Azure Key Vault からシークレット名のリストを返します。

このメソッドはシークレット値を返しません。
set_secret

ワークスペースに関連付けられている Azure Key Vault にシークレットを追加します。
set_secrets

ワークスペースに関連付けられている Azure Key Vault にシークレットの辞書を追加します。

delete_secret

指定された名前のシークレットを削除します。

delete_secret(name)

パラメーター

name
str
必須

削除するシークレットの名前。

の戻り値の型 :

None

delete_secrets

ワークスペースに関連付けられている Azure Key Vault からシークレットのリストを削除します。

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 Key Vault からシークレット名のリストを返します。

このメソッドはシークレット値を返しません。

list_secrets()

戻り値

{name : "secretName"} という形式のシークレット名の辞書のリスト

の戻り値の型 :

dict(<xref:str:str>)

set_secret

ワークスペースに関連付けられている Azure Key Vault にシークレットを追加します。

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 Key Vault にシークレットの辞書を追加します。

set_secrets(secrets_batch)

パラメーター

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

追加するシークレットの名前と値の辞書。

の戻り値の型 :

None