SslConfiguration クラス

  • リファレンス

AksCompute で使用される SSL 構成オブジェクトを表します。

SslConfiguration オブジェクトを初期化します。

継承
builtins.object
SslConfiguration

コンストラクター

SslConfiguration(status=None, cert=None, key=None, cname=None, leaf_domain_label=None, overwrite_existing_domain=False, renew=False)

パラメーター

名前 説明
status
str

SSL 検証が有効になっているか、無効になっているか、または自動であるかを示します。

規定値: None
cert
str

SSL 検証に使用される証明書文字列。 指定した場合は、cname と key の PEM ファイルも指定する必要があります。

規定値: None
key
str

SSL 検証に使用されるキー文字列。 指定した場合は、cname と cert の PEM ファイルも指定する必要があります。

規定値: None
cname
str

SSL 検証に使用される CNAME。 指定した場合は、cert と key の PEM ファイルも指定する必要があります。

規定値: None
leaf_domain_label
str

自動生成された証明書に使用されるリーフ ドメイン ラベル。

規定値: None
overwrite_existing_domain
bool

既存のリーフ ドメイン ラベルを上書きするかどうかを示します。 既定値は False です。

規定値: False
renew
bool

leaf_domain_label が自動生成された証明書を更新するかどうかを示します。 指定した場合は、既存の SSL 構成を自動にする必要があります。既定値は False です。

規定値: False
status
必須
str

SSL 検証が有効になっているか、無効になっているか、または自動であるかを示します。
cert
必須
str

SSL 検証に使用される証明書文字列。 指定した場合は、cname と key の PEM ファイルも指定する必要があります。
key
必須
str

SSL 検証に使用されるキー文字列。 指定した場合は、cname と cert の PEM ファイルも指定する必要があります。
cname
必須
str

SSL 検証に使用される CNAME。 指定した場合は、cert と key の PEM ファイルも指定する必要があります。
leaf_domain_label
必須
str

自動生成された証明書に使用されるリーフ ドメイン ラベル。
overwrite_existing_domain
必須
bool

既存のリーフ ドメイン ラベルを上書きするかどうかを示します。 既定値は False です。
renew
必須
bool

leaf_domain_label が自動生成された証明書を更新するかどうかを示します。 指定した場合は、既存の SSL 構成を自動にする必要があります。既定値は False です。

注釈

SSL を構成するには、leaf_domain_label パラメーターまたはパラメーターの cname、cert、および key を指定します。

SSL 構成を指定する一般的なパターンは、AksCompute クラスの attach_configuration メソッドまたは provisioning_configuration メソッドを使用して構成オブジェクトを取得することです。 その後で、返された構成オブジェクトの enable_ssl メソッドを使用します。 たとえば、attach 構成の場合は、enable_ssl メソッドを使用します。


   # Load workspace configuration from the config.json file.
   from azureml.core import Workspace
   ws = Workspace.from_config()

   # Use the default configuration, but you can also provide parameters to customize.
   from azureml.core.compute import AksCompute
   prov_config = AksCompute.provisioning_configuration()
   attach_config = AksCompute.attach_configuration(resource_group=ws.resource_group,
                                                   cluster_name="dev-cluster")

   # Enable ssl.
   prov_config.enable_ssl(leaf_domain_label = "contoso")
   attach_config.enable_ssl(leaf_domain_label = "contoso")

AKS に対して SSL を有効にする方法については、「SSL を使用して Azure Machine Learning による Web サービスをセキュリティで保護する」を参照してください。

メソッド

deserialize

JSON オブジェクトを SslConfiguration オブジェクトに変換します。
serialize

この SslConfiguration オブジェクトを JSON でシリアル化された辞書に変換します。

deserialize

JSON オブジェクトを SslConfiguration オブジェクトに変換します。

static deserialize(object_dict)

パラメーター

名前 説明
object_dict
必須
dict

SslConfiguration オブジェクトに変換する JSON オブジェクト。

戻り値

型 説明
SslConfiguration

指定された JSON オブジェクトの SslConfiguration 表現。

例外

型 説明
ComputeTargetException

serialize

この SslConfiguration オブジェクトを JSON でシリアル化された辞書に変換します。

serialize()

戻り値

型 説明
dict

この SslConfiguration オブジェクトの JSON 表現。

例外

型 説明
ComputeTargetException