AksWebservice 类
表示一个部署为 Azure Kubernetes 服务上 Web 服务终结点的机器学习模型。
从模型、脚本和关联的文件创建已部署的服务。 生成的 Web 服务是一个负载均衡、具有 REST API 的 HTTP 终结点。 可将数据发送到此 API，并接收模型返回的预测。
AksWebservice 将一个服务部署到一个终结点。 若要将多个服务部署到一个终结点，请使用 AksEndpoint 类。
有关详细信息，请参阅将模型部署到 Azure Kubernetes 服务群集。
初始化 Web 服务实例。
Webservice 构造函数检索与提供的工作区关联的 Webservice 对象的云表示形式。 它将返回与检索到的 Webservice 对象的特定类型对应的子类的实例。
- 继承
-
AksWebservice
构造函数
AksWebservice(workspace, name)参数
注解
建议的部署模式是使用 deploy_configuration 方法创建部署配置对象，然后将该对象与 Model 类的 deploy 方法一起使用，如下所示。
# Set the web service configuration (using default here)
aks_config = AksWebservice.deploy_configuration()
# # Enable token auth and disable (key) auth on the webservice
# aks_config = AksWebservice.deploy_configuration(token_auth_enabled=True, auth_enabled=False)
有多种方法可以将模型部署为 webservice，包括：
已在工作区中注册的模型的 Model 的
deploy方法。Webservice 的
deploy_from_image方法。已在工作区中注册的模型的 Webservice 的
deploy_from_model方法。 此方法将创建映像。Webservice 的
deploy方法，它将注册模型并创建映像。
有关使用 webservice 的信息，请参阅
“变量”部分列出了云 AksWebservice 对象的本地表示形式的属性。 应将这些变量视为只读。 更改其值不会反映在对应的云对象中。
变量
- enable_app_insights
- bool
是否为 Webservice 启用了 AppInsights 日志记录。
- autoscaler
- AutoScaler
Webservice 的自动缩放程序对象。
- compute_name
- str
将 Webservice 部署到的 ComputeTarget 的名称。
- container_resource_requirements
- ContainerResourceRequirements
Webservice 的容器资源要求。
- liveness_probe_requirements
- LivenessProbeRequirements
Webservice 的运行情况探测要求。
- data_collection
- DataCollection
Webservice 的 DataCollection 对象。
- max_concurrent_requests_per_container
- int
Webservice 的每个容器的最大并发请求数。
- max_request_wait_time
- int
Webservice 的最大请求等待时间，以毫秒为单位。
- num_replicas
- int
Webservice 的副本数。 每个副本对应于一个 AKS Pod。
- scoring_timeout_ms
- int
Webservice 的评分超时，以毫秒为单位。
- azureml.core.webservice.AksWebservice.scoring_uri
- str
Webservice 的评分终结点
- is_default
- bool
Webservice 是否为父 AksEndpoint 的默认版本。
- traffic_percentile
- int
要路由到父 AksEndpoint 中 Webservice 的流量百分比。
- version_type
- VersionType
父 AksEndpoint 中 Webservice 的版本类型。
- token_auth_enabled
- bool
是否为 Webservice 启用了令牌身份验证。
- environment
- Environment
用于创建 Webservice 的环境对象。
- deployment_status
- str
Webservice 的部署状态。
- namespace
- str
Webservice 的 AKS 命名空间。
- azureml.core.webservice.AksWebservice.swagger_uri
- str
Webservice 的 swagger 终结点。
方法
| add_properties |
将键值对添加到此 Webservice 的属性字典。 |
| add_tags |
将键值对添加到此 Webservice 的标记字典。 |
| deploy_configuration |
创建配置对象以部署到 AKS 计算目标。 |
| get_access_token |
检索此 Webservice 的身份验证令牌。 |
| get_token |
已弃用。 请改用 检索此 Webservice 的身份验证令牌。 |
| remove_tags |
从此 Webservice 的标记字典中删除指定的键。 |
| run |
使用提供的输入调用此 Web 服务。 |
| serialize |
将此 Webservice 转换为 JSON 序列化字典。 |
| update |
使用提供的属性更新 Webservice。 在此 Webservice 中，保留为 None 的值将保持不变。 |
add_properties
add_tags
将键值对添加到此 Webservice 的标记字典。
add_tags(tags)参数
例外
deploy_configuration
创建配置对象以部署到 AKS 计算目标。
static deploy_configuration(autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, auth_enabled=None, cpu_cores=None, memory_gb=None, enable_app_insights=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, primary_key=None, secondary_key=None, tags=None, properties=None, description=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, namespace=None, token_auth_enabled=None, compute_target_name=None, cpu_cores_limit=None, memory_gb_limit=None, blobfuse_enabled=None)参数
- cpu_cores
- float
要分配给此 Webservice 的 CPU 核心数。 可以是小数。 默认值为 0.1。 对应于 Azure Kubernetes 服务中的 Pod 核心请求，而不是限制。
- memory_gb
- float
为此 Webservice 分配的内存量 (GB)。 可以是小数。 默认值为 0.5。 对应于 Azure Kubernetes 服务中的 Pod 内存请求，而不是限制。
- replica_max_concurrent_requests
- int
允许用于此 Webservice 的每个副本的最大并发请求数。 默认值为 1。 除非获得 Microsoft 技术支持人员或 Azure 机器学习团队成员的指导，否则不要更改此设置的默认值 1。
- failure_threshold
- int
当 Pod 启动而运行情况探测失败时，Kubernetes 将尝试 failureThreshold 次才会放弃。 默认值为 3。 最小值为 1。
- namespace
- str
要在其中部署此 Web 服务的 Kubernetes 命名空间：最多 63 个小写字母数字（“a”-“z”、“0”-“9”）和连字符（“-”）。 第一个和最后一个字符不能为连字符。
- token_auth_enabled
- bool
是否为此 Webservice 启用令牌身份验证。 如果启用此功能，则用户可以通过使用使用其 Azure Active Directory 凭据提取访问令牌来访问此 Webservice。 默认为 False。
返回
部署 AksWebservice 时要使用的配置对象。
返回类型
例外
get_access_token
检索此 Webservice 的身份验证令牌。
get_access_token()返回
用于描述此 Webservice 的身份验证令牌的对象。
返回类型
例外
get_token
已弃用。 请改用 get_access_token 方法。
检索此 Webservice 的身份验证令牌。
get_token()返回
此 Webservice 的身份验证令牌以及何时刷新此令牌。
返回类型
例外
remove_tags
run
使用提供的输入调用此 Web 服务。
run(input_data)参数
- input_data
- <xref:varies>
用于调用 Webservice 的输入
返回
调用 Web 服务后的结果
返回类型
例外
serialize
update
使用提供的属性更新 Webservice。
在此 Webservice 中，保留为 None 的值将保持不变。
update(image=None, autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, auth_enabled=None, cpu_cores=None, memory_gb=None, enable_app_insights=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, tags=None, properties=None, description=None, models=None, inference_config=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, namespace=None, token_auth_enabled=None, cpu_cores_limit=None, memory_gb_limit=None, **kwargs)参数
- failure_threshold
- int
当 Pod 启动而运行情况探测失败时，Kubernetes 将尝试 failureThreshold 次才会放弃。 默认值为 3。 最小值为 1。
- namespace
- str
要在其中部署此 Web 服务的 Kubernetes 命名空间：最多 63 个小写字母数字（“a”-“z”、“0”-“9”）和连字符（“-”）。 第一个和最后一个字符不能为连字符。
- token_auth_enabled
- bool
是否为此 Webservice 启用令牌身份验证。 如果启用此功能，则用户可以通过使用其 Azure Active Directory 凭据提取访问令牌来访问此 Webservice。 默认为 False
- kwargs
- <xref:varies>
包括参数，以支持将 AKS Web 服务迁移到 Kubernetes 联机终结点和部署。 is_migration=True|False, compute_target=.
例外
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈