AksServiceDeploymentConfiguration 類別

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

使用 deploy_configuration 類別的 AksWebservice 方法建立 AksServiceDeploymentConfiguration 物件。

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

繼承
AksServiceDeploymentConfiguration

建構函式

AksServiceDeploymentConfiguration(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, compute_target_name, cpu_cores_limit, memory_gb_limit, blobfuse_enabled=None)

參數

cpu_cores_limit
必要

允許此 Webservice 使用的 CPU 核心數目上限。 可以是十進位。

memory_gb_limit
必要

允許使用此 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
必要

自動調整程式應該嘗試維護此 Web 服務的目標使用率 (百分比為 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
必要

是否要為此 Webservice 啟用 Application Insights 記錄。 預設為 False

scoring_timeout_ms
int
必要

強制對此 Web 服務進行評分呼叫的逾時。 預設值為 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
必要

要用於此 Webservice 的次要驗證金鑰。

tags
dict[str, str]
必要

索引鍵值標籤的字典,以提供此 Web 服務。

properties
dict[str, str]
必要

索引鍵值屬性的字典,以提供此 Web 服務。 部署之後無法變更這些屬性,不過可以新增新的索引鍵值組。

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。

cpu_cores_limit
必要

允許此 Webservice 使用的 CPU 核心數目上限。 可以是十進位。

memory_gb_limit
必要

允許使用此 Web 服務) 以 GB 為單位的最大記憶體 (量。 可以是十進位。

blobfuse_enabled
bool
預設值: None

是否要啟用 Blobfuse 以下載此 Webservice 的模型。 預設為 True

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
必要

是否要為此 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
必要

是否要為此 Webservice 啟用 Application Insights 記錄。 預設為 False

scoring_timeout_ms
int
必要

強制對此 Web 服務進行評分呼叫的逾時。 預設值為 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
必要

要用於此 Webservice 的次要驗證金鑰。

tags
dict[str, str]
必要

索引鍵值標籤的字典,以提供此 Web 服務。

properties
dict[str, str]
必要

索引鍵值屬性的字典,以提供此 Web 服務。 部署之後無法變更這些屬性,不過可以新增新的索引鍵值組。

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。

compute_target_name
str
必要

要部署的目標計算目標名稱

cpu_cores_limit
float
必要

允許此 Webservice 使用的 CPU 核心數目上限。 可以是十進位。

memory_gb_limit
float
必要

允許使用此 Web 服務) 以 GB 為單位的最大記憶體 (量。 可以是十進位。

blobfuse_enabled
bool
必要

是否要啟用 Blobfuse 以下載此 Webservice 的模型。 預設為 True

變數

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

是否要為此 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

是否要為此 Webservice 啟用 Application Insights 記錄。 預設為 False

scoring_timeout_ms
int

強制對此 Web 服務進行評分呼叫的逾時。 預設值為 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

要用於此 Webservice 的次要驗證金鑰。

azureml.core.webservice.AksServiceDeploymentConfiguration.tags

索引鍵值標籤的字典,以提供此 Web 服務。

azureml.core.webservice.AksServiceDeploymentConfiguration.properties

索引鍵值屬性的字典,以提供此 Web 服務。 部署之後無法變更這些屬性,不過可以新增新的索引鍵值組。

azureml.core.webservice.AksServiceDeploymentConfiguration.description

提供此 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。

azureml.core.webservice.AksServiceDeploymentConfiguration.namespace

要在其中部署此 Webservice 的 Kubernetes 命名空間:最多 63 個小寫英數位元 ('a'-'z'、'0'-'9') 和連字號 ('-') 字元。 第一個字元和最後一個字元不能是連字號。

token_auth_enabled
bool

是否要為此 Web 服務啟用 Azure Active Directory 驗證。 如果啟用此功能,使用者可以使用其 Azure Active Directory 認證來擷取存取權杖,以存取此 Web 服務。 預設為 False。

方法

print_deploy_configuration

列印部署組態。

validate_configuration

檢查指定的組態值是否有效。

如果驗證失敗,將會引發 WebserviceException。

print_deploy_configuration

列印部署組態。

print_deploy_configuration()

validate_configuration

檢查指定的組態值是否有效。

如果驗證失敗,將會引發 WebserviceException。

validate_configuration()

例外狀況