AksEndpointDeploymentConfiguration 類別

備註

這是實驗性類別，隨時可能會變更。 如需詳細資訊，請參閱 https://aka.ms/acr/connected-registry 。

代表部署在 Azure Kubernetes Service 上之服務的部署組態資訊。

使用 deploy_configuration 類別的 AksEndpoint 方法建立 AksEndpointDeploymentConfiguration 物件。

初始化組態物件，以將端點部署至 AKS 計算目標。

建構函式

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)

參數

名稱	Description
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 自動調整程式應嘗試針對此 Webservice 維護目標使用率（以百分之 100 的百分比為單位）。 預設值為 70。
collect_model_data 必要	bool 是否要啟用此 Webservice 的模型數據收集。 預設為 False。
auth_enabled 必要	bool 是否要啟用此 Web 服務的驗證。 預設值為 True。
cpu_cores 必要	float 要配置給此 Webservice 的 CPU 核心數目。 可以是十進位。 預設值為 0.1
memory_gb 必要	float 要配置給此 Webservice 的記憶體數量（以 GB 為單位）。 可以是十進位。 預設值為 0.5
enable_app_insights 必要	bool 是否要啟用此 Web 服務的 Application Insights 記錄。 預設為 False。
scoring_timeout_ms 必要	int 要強制對這個 Webservice 進行評分呼叫的逾時。 預設值為 60000。
replica_max_concurrent_requests 必要	int 每個復本允許此 Webservice 的最大並行要求數目。 預設值為 1。 除非Microsoft技術支援或 Azure Machine Learning 小組的成員指示，否則請勿從預設值 1 變更此設定。
max_request_wait_time 必要	int 要求在傳回 503 錯誤之前，要求在佇列中停留的時間上限（以毫秒為單位）。 預設值為 500。
num_replicas 必要	int 要配置給這個 Webservice 的容器數目。 沒有預設值，如果未設定此參數，則預設會啟用自動調整程式。
primary_key 必要	str 用於此 Web 服務的主要驗證金鑰
secondary_key 必要	str 用於此 Web 服務的次要驗證金鑰
tags 必要	dict[str, str] 索引鍵值標籤的字典，以提供此 Webservice
properties 必要	dict[str, str] 要提供此 Webservice 的索引鍵值屬性字典。 部署之後就無法變更這些屬性，但是可以新增新的索引鍵值組。
description 必要	str 提供此 Webservice 的描述。
gpu_cores 必要	int 要配置給此 Webservice 的 GPU 核心數目。 預設值為 0。
period_seconds 必要	int 執行活躍度探查的頻率 (以秒為單位)。 預設為10秒。 最小值為 1。
initial_delay_seconds 必要	int 在起始活躍度探查之前，容器啟動后的秒數。 預設值為310。
timeout_seconds 必要	int 即時探查逾時后的秒數。預設為2秒。 最小值為 1。
success_threshold 必要	int 生存度探查在失敗后要視為成功的最小連續成功。 預設值為 1。 最小值為 1。
failure_threshold 必要	int 當 Pod 啟動時，且活躍度探查失敗時，Kubernetes 會在放棄之前嘗試 failureThreshold 時間。 預設值為 3。 最小值為 1。
namespace 必要	str 用來部署此 Webservice 的 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 此 Webservice 允許使用此 Web 服務的最大 CPU 核心數目。 可以是十進位。
memory_gb_limit 必要	float 允許此 Web 服務使用的記憶體數量上限（以 GB 為單位）。 可以是十進位。
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 自動調整程式應嘗試針對此 Webservice 維護目標使用率（以百分之 100 的百分比為單位）。 預設值為 70。
collect_model_data 必要	bool 是否要啟用此 Webservice 的模型數據收集。 預設為 False。
auth_enabled 必要	bool 是否要啟用此 Web 服務的驗證。 預設值為 True。
cpu_cores 必要	float 要配置給此 Webservice 的 CPU 核心數目。 可以是十進位。 預設值為 0.1
memory_gb 必要	float 要配置給此 Webservice 的記憶體數量（以 GB 為單位）。 可以是十進位。 預設值為 0.5
enable_app_insights 必要	bool 是否要啟用此 Web 服務的 Application Insights 記錄。 預設為 False。
scoring_timeout_ms 必要	int 要強制對這個 Webservice 進行評分呼叫的逾時。 預設值為 60000。
replica_max_concurrent_requests 必要	int 每個復本允許此 Webservice 的最大並行要求數目。 預設值為 1。 除非Microsoft技術支援或 Azure Machine Learning 小組的成員指示，否則請勿從預設值 1 變更此設定。
max_request_wait_time 必要	int 要求在傳回 503 錯誤之前，要求在佇列中停留的時間上限（以毫秒為單位）。 預設值為 500。
num_replicas 必要	int 要配置給這個 Webservice 的容器數目。 沒有預設值，如果未設定此參數，則預設會啟用自動調整程式。
primary_key 必要	str 用於此 Web 服務的主要驗證金鑰
secondary_key 必要	str 用於此 Web 服務的次要驗證金鑰
tags 必要	dict[str, str] 索引鍵值標籤的字典，以提供此 Webservice
properties 必要	dict[str, str] 要提供此 Webservice 的索引鍵值屬性字典。 部署之後就無法變更這些屬性，但是可以新增新的索引鍵值組。
description 必要	str 提供此 Webservice 的描述。
gpu_cores 必要	int 要配置給此 Webservice 的 GPU 核心數目。 預設值為 0。
period_seconds 必要	int 執行活躍度探查的頻率 (以秒為單位)。 預設為10秒。 最小值為 1。
initial_delay_seconds 必要	int 在起始活躍度探查之前，容器啟動后的秒數。 預設值為310。
timeout_seconds 必要	int 即時探查逾時后的秒數。預設為2秒。 最小值為 1。
success_threshold 必要	int 生存度探查在失敗后要視為成功的最小連續成功。 預設值為 1。 最小值為 1。
failure_threshold 必要	int 當 Pod 啟動時，且活躍度探查失敗時，Kubernetes 會在放棄之前嘗試 failureThreshold 時間。 預設值為 3。 最小值為 1。
namespace 必要	str 用來部署此 Webservice 的 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 允許使用此 Web 服務的最大 CPU 核心數目。 可以是十進位。
memory_gb_limit 必要	float 允許此 Web 服務使用的記憶體數量上限（以 GB 為單位）。 可以是十進位。

變數

名稱	Description
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	自動調整程式應嘗試針對此 Webservice 維護目標使用率（以百分之 100 的百分比為單位）。 預設值為 70。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.collect_model_data	是否要啟用此 Webservice 的模型數據收集。 預設為 False。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.auth_enabled	是否要啟用此 Web 服務的驗證。 預設值為 True。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.cpu_cores	要配置給此 Webservice 的 CPU 核心數目。 可以是十進位。 預設值為 0.1
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.memory_gb	要配置給此 Webservice 的記憶體數量（以 GB 為單位）。 可以是十進位。 預設值為 0.5
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.enable_app_insights	是否要啟用此 Web 服務的 Application Insights 記錄。 預設為 False。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.scoring_timeout_ms	要強制對這個 Webservice 進行評分呼叫的逾時。 預設值為 60000。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.replica_max_concurrent_requests	每個復本允許此 Webservice 的最大並行要求數目。 預設值為 1。 除非Microsoft技術支援或 Azure Machine Learning 小組的成員指示，否則請勿從預設值 1 變更此設定。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.max_request_wait_time	要求在傳回 503 錯誤之前，要求在佇列中停留的時間上限（以毫秒為單位）。 預設值為 500。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.num_replicas	要配置給這個 Webservice 的容器數目。 沒有預設值，如果未設定此參數，則預設會啟用自動調整程式。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.primary_key	用於此 Web 服務的主要驗證金鑰
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.secondary_key	用於此 Web 服務的次要驗證金鑰
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.tags	索引鍵值標籤的字典，以提供此 Webservice
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.properties	要提供此 Webservice 的索引鍵值屬性字典。 部署之後就無法變更這些屬性，但是可以新增新的索引鍵值組。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.description	提供此 Webservice 的描述。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.gpu_cores	要配置給此 Webservice 的 GPU 核心數目。 預設值為 0。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.period_seconds	執行活躍度探查的頻率 (以秒為單位)。 預設為10秒。 最小值為 1。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.initial_delay_seconds	在起始活躍度探查之前，容器啟動后的秒數。 預設值為310。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.timeout_seconds	即時探查逾時后的秒數。預設為2秒。 最小值為 1。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.success_threshold	生存度探查在失敗后要視為成功的最小連續成功。 預設值為 1。 最小值為 1。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.failure_threshold	當 Pod 啟動時，且活躍度探查失敗時，Kubernetes 會在放棄之前嘗試 failureThreshold 時間。 預設值為 3。 最小值為 1。
azureml.core.webservice.aks.AksEndpointDeploymentConfiguration.namespace	用來部署此 Webservice 的 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()

例外狀況

類型	Description
WebserviceException