AksEndpointDeploymentConfiguration クラス

Note

これは試験段階のクラスであり、いつでも変更される可能性があります。 詳細については、https://aka.ms/azuremlexperimental を参照してください。

Azure Kubernetes Service 上にデプロイされたサービスのデプロイ構成情報を表します。

AksEndpoint クラスの deploy_configuration メソッドを使用して、AksEndpointDeploymentConfiguration オブジェクトを作成します。

エンドポイントを AKS コンピューティング ターゲットにデプロイするための構成オブジェクトを初期化します。

継承

AksServiceDeploymentConfiguration

AksEndpointDeploymentConfiguration

コンストラクター

AksEndpointDeploymentConfiguration(autoscale_enabled, autoscale_min_replicas, autoscale_max_replicas, autoscale_refresh_seconds, autoscale_target_utilization, collect_model_data, auth_enabled, cpu_cores, memory_gb, enable_app_insights, scoring_timeout_ms, replica_max_concurrent_requests, max_request_wait_time, num_replicas, primary_key, secondary_key, tags, properties, description, gpu_cores, period_seconds, initial_delay_seconds, timeout_seconds, success_threshold, failure_threshold, namespace, token_auth_enabled, version_name, traffic_percentile, compute_target_name, cpu_cores_limit, memory_gb_limit)

パラメーター

autoscale_enabled

bool

必須

この Web サービスに対して自動スケーリングを有効にするかどうか。 num_replicas が None の場合、既定値は True です。

autoscale_min_replicas

int

必須

この Web サービスを自動スケーリングするときに使用するコンテナーの最小数。 既定値は 1 です。

autoscale_max_replicas

int

必須

この Web サービスを自動スケーリングするときに使用するコンテナーの最大数。 既定値は 10 です。

autoscale_refresh_seconds

int

必須

自動スケーラーがこの Web サービスのスケーリングを試行する頻度。 既定値は 1 です。

autoscale_target_utilization

int

必須

自動スケーラーがこの Web サービスに対してメンテナンスを試行するターゲット使用率 (最大 100%)。 既定値は 70 です。

collect_model_data

bool

必須

この Web サービスに対してモデル データ収集を有効にするかどうか。 既定値は False です。

auth_enabled

bool

必須

この Web サービスに対して認証を有効にするかどうか。 既定値は True です。

cpu_cores

float

必須

この Web サービスに割り当てる CPU コアの数。 10 進数を指定できます。 既定値は 0.1 です

memory_gb

float

必須

この Web サービスに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。 既定値は 0.5 です

enable_app_insights

bool

必須

この Web サービスに対して Application Insights ログを有効にするかどうか。 既定値は False です。

scoring_timeout_ms

int

必須

この Web サービスに対するスコアリング呼び出しに適用するタイムアウト。 既定値は 60000 です。

replica_max_concurrent_requests

int

必須

この Web サービスに対して許可するレプリカあたりの同時要求の最大数。 既定値は 1 です。 この設定は、マイクロソフト テクニカル サポートまたはマイクロソフトの Azure Machine Learning チームのメンバーの指示がない限り、既定値の 1 してください。

max_request_wait_time

int

必須

503 エラーを返すまでに、要求がキューに置かれる最大時間 (ミリ秒単位)。 既定値は 500 です。

num_replicas

int

必須

この Web サービスに割り当てるコンテナーの数。 既定値はありません。このパラメーターが設定されない場合、自動スケーラーは既定で有効になります。

primary_key

str

必須

この Web サービスに使用するプライマリ認証キー

secondary_key

str

必須

この Web サービスに使用するセカンダリ認証キー

tags

dict[str, str]

必須

この Web サービスに提供するキー値タグの辞書

properties

dict[str, str]

必須

この Web サービスに提供するキー値プロパティの辞書。 これらのプロパティはデプロイ後は変更できません。ただし、新しいキー値のペアを追加することはできます。

description

str

必須

この Web サービスに提供する説明。

gpu_cores

int

必須

この Web サービスに割り当てる GPU コアの数。 既定値は 0 です。

period_seconds

int

必須

liveness probe を実行する頻度 (秒単位)。 既定値は 10 秒です。 最大値は 1 です。

initial_delay_seconds

int

必須

コンテナーの起動後、liveness probe が開始するまでの秒数。 既定値は 310 です。

timeout_seconds

int

必須

liveness probe がタイムアウトするまでの秒数。既定値は 2 秒です。 最大値は 1 です。

success_threshold

int

必須

失敗した後、liveness probe が成功と見なされるための最小連続成功数。 既定値は 1 です。 最大値は 1 です。

failure_threshold

int

必須

Pod が起動し、liveness probe が失敗した場合、Kubernetes は failureThreshold 回試してから、あきらめます。 既定値は 3 です。 最大値は 1 です。

namespace

str

必須

この Web サービスをデプロイする Kubernetes 名前空間: 最大 63 文字の小文字の英数字 ('a'-'z'、'0'-'9') とハイフン ('-')。 先頭と末尾の文字をハイフンにすることはできません。

token_auth_enabled

bool

必須

この Web サービスに対して Azure Active Directory 認証を有効にするかどうか。 これが有効になっている場合、ユーザーは Azure Active Directory の資格情報を使用してアクセス トークンをフェッチすることで、この Web サービスにアクセスできます。 既定値は False です。

version_name

str

必須

エンドポイント内のバージョンの名前。

traffic_percentile

float

必須

バージョンがエンドポイント内で受け取るトラフィックの量。

cpu_cores_limit

float

必須

この Web サービスで使用できる CPU コアの最大数。 10 進数を指定できます。

memory_gb_limit

float

必須

この Web サービスで使用できるメモリの最大量 (GB 単位)。 10 進数を指定できます。

autoscale_enabled

bool

必須

この Web サービスに対して自動スケーリングを有効にするかどうか。 num_replicas が None の場合、既定値は True です。

autoscale_min_replicas

int

必須

この Web サービスを自動スケーリングするときに使用するコンテナーの最小数。 既定値は 1 です。

autoscale_max_replicas

int

必須

この Web サービスを自動スケーリングするときに使用するコンテナーの最大数。 既定値は 10 です。

autoscale_refresh_seconds

int

必須

自動スケーラーがこの Web サービスのスケーリングを試行する頻度。 既定値は 1 です。

autoscale_target_utilization

int

必須

自動スケーラーがこの Web サービスに対してメンテナンスを試行するターゲット使用率 (最大 100%)。 既定値は 70 です。

collect_model_data

bool

必須

この Web サービスに対してモデル データ収集を有効にするかどうか。 既定値は False です。

auth_enabled

bool

必須

この Web サービスに対して認証を有効にするかどうか。 既定値は True です。

cpu_cores

float

必須

この Web サービスに割り当てる CPU コアの数。 10 進数を指定できます。 既定値は 0.1 です

memory_gb

float

必須

この Web サービスに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。 既定値は 0.5 です

enable_app_insights

bool

必須

この Web サービスに対して Application Insights ログを有効にするかどうか。 既定値は False です。

scoring_timeout_ms

int

必須

この Web サービスに対するスコアリング呼び出しに適用するタイムアウト。 既定値は 60000 です。

replica_max_concurrent_requests

int

必須

この Web サービスに対して許可するレプリカあたりの同時要求の最大数。 既定値は 1 です。 この設定は、マイクロソフト テクニカル サポートまたはマイクロソフトの Azure Machine Learning チームのメンバーの指示がない限り、既定値の 1 してください。

max_request_wait_time

int

必須

503 エラーを返すまでに、要求がキューに置かれる最大時間 (ミリ秒単位)。 既定値は 500 です。

num_replicas

int

必須

この Web サービスに割り当てるコンテナーの数。 既定値はありません。このパラメーターが設定されない場合、自動スケーラーは既定で有効になります。

primary_key

str

必須

この Web サービスに使用するプライマリ認証キー

secondary_key

str

必須

この Web サービスに使用するセカンダリ認証キー

tags

dict[str, str]

必須

この Web サービスに提供するキー値タグの辞書

properties

dict[str, str]

必須

この Web サービスに提供するキー値プロパティの辞書。 これらのプロパティはデプロイ後は変更できません。ただし、新しいキー値のペアを追加することはできます。

description

str

必須

この Web サービスに提供する説明。

gpu_cores

int

必須

この Web サービスに割り当てる GPU コアの数。 既定値は 0 です。

period_seconds

int

必須

liveness probe を実行する頻度 (秒単位)。 既定値は 10 秒です。 最大値は 1 です。

initial_delay_seconds

int

必須

コンテナーの起動後、liveness probe が開始するまでの秒数。 既定値は 310 です。

timeout_seconds

int

必須

liveness probe がタイムアウトするまでの秒数。既定値は 2 秒です。 最大値は 1 です。

success_threshold

int

必須

失敗した後、liveness probe が成功と見なされるための最小連続成功数。 既定値は 1 です。 最大値は 1 です。

failure_threshold

int

必須

Pod が起動し、liveness probe が失敗した場合、Kubernetes は failureThreshold 回試してから、あきらめます。 既定値は 3 です。 最大値は 1 です。

namespace

str

必須

この Web サービスをデプロイする Kubernetes 名前空間: 最大 63 文字の小文字の英数字 ('a'-'z'、'0'-'9') とハイフン ('-')。 先頭と末尾の文字をハイフンにすることはできません。

token_auth_enabled

bool

必須

この Web サービスに対して Azure Active Directory 認証を有効にするかどうか。 これが有効になっている場合、ユーザーは Azure Active Directory の資格情報を使用してアクセス トークンをフェッチすることで、この Web サービスにアクセスできます。 既定値は False です。

version_name

str

必須

エンドポイント内のバージョンの名前。

traffic_percentile

float

必須

バージョンがエンドポイント内で受け取るトラフィックの量。

compute_target_name

str

必須

デプロイするコンピューティング先の名前

cpu_cores_limit

float

必須

この Webservice で使用できる CPU コアの最大数。 10 進数を指定できます。

memory_gb_limit

float

必須

この Web サービスで使用できるメモリの最大量 (GB 単位)。 10 進数を指定できます。

変数

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_enabled

この Web サービスに対して自動スケーリングを有効にするかどうか。 num_replicas が None の場合、既定値は True です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_min_replicas

この Web サービスを自動スケーリングするときに使用するコンテナーの最小数。 既定値は 1 です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_max_replicas

この Web サービスを自動スケーリングするときに使用するコンテナーの最大数。 既定値は 10 です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_refresh_seconds

自動スケーラーがこの Web サービスのスケーリングを試行する頻度。 既定値は 1 です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.autoscale_target_utilization

自動スケーラーがこの Web サービスに対してメンテナンスを試行するターゲット使用率 (最大 100%)。 既定値は 70 です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.collect_model_data

この Web サービスに対してモデル データ収集を有効にするかどうか。 既定値は False です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.auth_enabled

この Web サービスに対して認証を有効にするかどうか。 既定値は True です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.cpu_cores

この Web サービスに割り当てる CPU コアの数。 10 進数を指定できます。 既定値は 0.1 です

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.memory_gb

この Web サービスに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。 既定値は 0.5 です

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.enable_app_insights

この Web サービスに対して Application Insights ログを有効にするかどうか。 既定値は False です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.scoring_timeout_ms

この Web サービスに対するスコアリング呼び出しに適用するタイムアウト。 既定値は 60000 です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.replica_max_concurrent_requests

この Web サービスに対して許可するレプリカあたりの同時要求の最大数。 既定値は 1 です。 この設定は、マイクロソフト テクニカル サポートまたはマイクロソフトの Azure Machine Learning チームのメンバーの指示がない限り、既定値の 1 してください。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.max_request_wait_time

503 エラーを返すまでに、要求がキューに置かれる最大時間 (ミリ秒単位)。 既定値は 500 です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.num_replicas

この Web サービスに割り当てるコンテナーの数。 既定値はありません。このパラメーターが設定されない場合、自動スケーラーは既定で有効になります。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.primary_key

この Web サービスに使用するプライマリ認証キー

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.secondary_key

この Web サービスに使用するセカンダリ認証キー

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.tags

この Web サービスに提供するキー値タグの辞書

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.properties

この Web サービスに提供するキー値プロパティの辞書。 これらのプロパティはデプロイ後は変更できません。ただし、新しいキー値のペアを追加することはできます。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.description

この Web サービスに提供する説明。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.gpu_cores

この Web サービスに割り当てる GPU コアの数。 既定値は 0 です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.period_seconds

liveness probe を実行する頻度 (秒単位)。 既定値は 10 秒です。 最大値は 1 です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.initial_delay_seconds

コンテナーの起動後、liveness probe が開始するまでの秒数。 既定値は 310 です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.timeout_seconds

liveness probe がタイムアウトするまでの秒数。既定値は 2 秒です。 最大値は 1 です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.success_threshold

失敗した後、liveness probe が成功と見なされるための最小連続成功数。 既定値は 1 です。 最大値は 1 です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.failure_threshold

Pod が起動し、liveness probe が失敗した場合、Kubernetes は failureThreshold 回試してから、あきらめます。 既定値は 3 です。 最大値は 1 です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.namespace

この Web サービスをデプロイする Kubernetes 名前空間: 最大 63 文字の小文字の英数字 ('a'-'z'、'0'-'9') とハイフン ('-')。 先頭と末尾の文字をハイフンにすることはできません。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.token_auth_enabled

この Web サービスに対して Azure Active Directory 認証を有効にするかどうか。 これが有効になっている場合、ユーザーは Azure Active Directory の資格情報を使用してアクセス トークンをフェッチすることで、この Web サービスにアクセスできます。 既定値は False です。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.version_name

エンドポイント内のバージョンの名前。

azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.traffic_percentile

バージョンがエンドポイント内で受け取るトラフィックの量。

メソッド

validate_endpoint_configuration

指定された構成値が有効であることを確認します。 検証が失敗した場合、WebserviceException が発生します。

validate_endpoint_configuration

指定された構成値が有効であることを確認します。

検証が失敗した場合、WebserviceException が発生します。

validate_endpoint_configuration()

例外

WebserviceException