AksCompute クラス
Azure Machine Learning 内で Azure Kubernetes Service のコンピューティング先を管理します。
Azure Kubernetes Service (AKSCompute) のターゲットは、デプロイされたサービスの高速な応答時間と自動スケールを実現できるため、通常は大規模な運用環境のデプロイに使用されます。 詳細については、Azure Machine Learning でのコンピューティング先 に関する記事をご覧ください。
ComputeTarget クラスコンストラクター。
指定されたワークスペースに関連付けられている Compute オブジェクトのクラウド表現を取得します。 取得した Compute オブジェクトの特定の型に対応する子クラスのインスタンスを返します。
- 継承
-
AksCompute
コンストラクター
AksCompute(workspace, name)パラメーター
| 名前 | 説明 |
|---|---|
|
workspace
必須
|
取得する AksCompute オブジェクトが含まれているワークスペース オブジェクト。 |
|
name
必須
|
取得する AksCompute オブジェクトの名前。 |
|
workspace
必須
|
取得する Compute オブジェクトを含むワークスペース オブジェクト。 |
|
name
必須
|
取得する Compute オブジェクトの の名前。 |
注釈
次のサンプルは、FPGA 対応マシンで AKS クラスターを作成する方法を示しています。
from azureml.core.compute import AksCompute, ComputeTarget
# Uses the specific FPGA enabled VM (sku: Standard_PB6s)
# Standard_PB6s are available in: eastus, westus2, westeurope, southeastasia
prov_config = AksCompute.provisioning_configuration(vm_size = "Standard_PB6s",
agent_count = 1,
location = "eastus")
aks_name = 'my-aks-pb6'
# Create the cluster
aks_target = ComputeTarget.create(workspace = ws,
name = aks_name,
provisioning_configuration = prov_config)
メソッド
| attach |
非推奨。 代わりに、 既存の AKS コンピューティング リソースを、指定されたワークスペースに関連付けます。 |
| attach_configuration |
AKS コンピューティング先をアタッチするための構成オブジェクトを作成します。 |
| delete |
AksCompute オブジェクトを、それが関連付けられているワークスペースから削除します。 このオブジェクトが Azure Machine Learning によって作成された場合は、対応するクラウド ベースのオブジェクトも削除されます。 このオブジェクトが外部で作成され、ワークスペースにアタッチされているだけの場合、このメソッドによって ComputeTargetException が発生し、何も変更されません。 |
| deserialize |
JSON オブジェクトを AksCompute オブジェクトに変換します。 |
| detach |
AksCompute オブジェクトを、それが関連付けられているワークスペースからデタッチします。 基になるクラウド オブジェクトは削除されず、関連付けだけが削除されます。 |
| get_credentials |
AKS ターゲットの資格情報を取得します。 |
| provisioning_configuration |
AKS コンピューティング先をプロビジョニングするための構成オブジェクトを作成します。 |
| refresh_state |
オブジェクトのプロパティのインプレース更新を実行します。 このメソッドは、対応するクラウド オブジェクトの現在の状態に基づいてプロパティを更新します。 これは主に、コンピューティング状態の手動ポーリングに使用されます。 |
| serialize |
この AksCompute オブジェクトを、JSON でシリアル化された辞書に変換します。 |
| update |
指定された更新構成を使用して AksCompute オブジェクトを更新します。 |
attach
非推奨。 代わりに、attach_configuration メソッドを使用してください。
既存の AKS コンピューティング リソースを、指定されたワークスペースに関連付けます。
static attach(workspace, name, resource_id)パラメーター
| 名前 | 説明 |
|---|---|
|
workspace
必須
|
コンピューティング リソースを関連付けるワークスペース オブジェクト。 |
|
name
必須
|
指定されたワークスペース内のコンピューティング リソースに関連付ける名前。 アタッチするコンピューティング リソースの名前と一致する必要はありません。 |
|
resource_id
必須
|
アタッチされているコンピューティング リソースの Azure リソース ID。 |
戻り値
| 型 | 説明 |
|---|---|
|
コンピューティング オブジェクトの AksCompute オブジェクト表現。 |
例外
| 型 | 説明 |
|---|---|
attach_configuration
AKS コンピューティング先をアタッチするための構成オブジェクトを作成します。
static attach_configuration(resource_group=None, cluster_name=None, resource_id=None, cluster_purpose=None, load_balancer_type=None, load_balancer_subnet=None)パラメーター
| 名前 | 説明 |
|---|---|
|
resource_group
|
AKS が存在するリソース グループの名前。 規定値: None
|
|
cluster_name
|
AKS クラスター名。 規定値: None
|
|
resource_id
|
アタッチされているコンピューティング リソースの Azure リソース ID。 規定値: None
|
|
cluster_purpose
|
クラスターの目的とする使用方法。 これは、Azure Machine Learning コンポーネントをプロビジョニングして必要なレベルのフォールト トレランスと QoS を確保するために使用されます。 ClusterPurpose クラスは、指定できる値を定義します。 詳細については、「既存の AKS クラスターをアタッチする」を参照してください。 規定値: None
|
|
load_balancer_type
|
AKS クラスターの種類。 有効な値は、PublicIp と InternalLoadBalancer です。 既定値は PublicIp です。 規定値: None
|
|
load_balancer_subnet
|
AKS ロード バランサー サブネット。 これは、ロード バランサーの種類として InternalLoadBalancer を使用する場合にのみ使用できます。 既定値は aks-subnet です。 規定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
コンピューティング オブジェクトをアタッチするときに使用する構成オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
delete
AksCompute オブジェクトを、それが関連付けられているワークスペースから削除します。
このオブジェクトが Azure Machine Learning によって作成された場合は、対応するクラウド ベースのオブジェクトも削除されます。 このオブジェクトが外部で作成され、ワークスペースにアタッチされているだけの場合、このメソッドによって ComputeTargetException が発生し、何も変更されません。
delete()例外
| 型 | 説明 |
|---|---|
deserialize
JSON オブジェクトを AksCompute オブジェクトに変換します。
static deserialize(workspace, object_dict)パラメーター
| 名前 | 説明 |
|---|---|
|
workspace
必須
|
AksCompute オブジェクトが関連付けられているワークスペース オブジェクト。 |
|
object_dict
必須
|
AksCompute オブジェクトに変換する JSON オブジェクト。 |
戻り値
| 型 | 説明 |
|---|---|
|
指定された JSON オブジェクトの AksCompute 表現。 |
例外
| 型 | 説明 |
|---|---|
注釈
指定されたワークスペースが、Compute が関連付けられているワークスペースでない場合、ComputeTargetException を発生させます。
detach
AksCompute オブジェクトを、それが関連付けられているワークスペースからデタッチします。
基になるクラウド オブジェクトは削除されず、関連付けだけが削除されます。
detach()例外
| 型 | 説明 |
|---|---|
get_credentials
AKS ターゲットの資格情報を取得します。
get_credentials()戻り値
| 型 | 説明 |
|---|---|
|
AKS ターゲットの資格情報。 |
例外
| 型 | 説明 |
|---|---|
provisioning_configuration
AKS コンピューティング先をプロビジョニングするための構成オブジェクトを作成します。
static provisioning_configuration(agent_count=None, vm_size=None, ssl_cname=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, location=None, vnet_resourcegroup_name=None, vnet_name=None, subnet_name=None, service_cidr=None, dns_service_ip=None, docker_bridge_cidr=None, cluster_purpose=None, load_balancer_type=None, load_balancer_subnet=None)パラメーター
| 名前 | 説明 |
|---|---|
|
agent_count
|
コンテナーをホストするエージェント (VM) の数。 既定値は 3 です。 規定値: None
|
|
vm_size
|
エージェント VM のサイズ。 オプションの完全なリストについては、https://aka.ms/azureml-aks-details を参照してください。 既定値は Standard_D3_v2 です。 規定値: None
|
|
ssl_cname
|
クラスター上で SSL 検証を有効にする場合に使用する CName。 SSL 検証を有効にするには、CName、証明書ファイル、キー ファイルの 3 つすべてを指定する必要があります。 規定値: None
|
|
ssl_cert_pem_file
|
SSL 検証用の証明書情報が含まれているファイルへのファイル パス。 SSL 検証を有効にするには、CName、証明書ファイル、キー ファイルの 3 つすべてを指定する必要があります。 規定値: None
|
|
ssl_key_pem_file
|
SSL 検証用のキー情報が含まれているファイルへのファイル パス。 SSL 検証を有効にするには、CName、証明書ファイル、キー ファイルの 3 つすべてを指定する必要があります。 規定値: None
|
|
location
|
クラスターをプロビジョニングする場所。 指定されていない場合は、既定のワークスペースの場所になります。 このコンピューティングで使用可能なリージョンは、次の場所にあります。https://azure.microsoft.com/global-infrastructure/services/?regions=all&products=kubernetes-service 規定値: None
|
|
vnet_resourcegroup_name
|
仮想ネットワークが配置されているリソース グループの名前。 規定値: None
|
|
vnet_name
|
仮想ネットワークの名前。 規定値: None
|
|
subnet_name
|
VNet 内のサブネットの名前。 規定値: None
|
|
service_cidr
|
Kubenet を使用している場合、サービス クラスター IP を割り当てる CIDR 表記の IP 範囲。 規定値: None
|
|
dns_service_ip
|
コンテナーの DNS サーバー IP アドレス。 規定値: None
|
|
docker_bridge_cidr
|
Docker ブリッジの CIDR 表記の IP。 規定値: None
|
|
cluster_purpose
|
クラスターの目的とする使用方法。 これは、Azure Machine Learning コンポーネントをプロビジョニングして必要なレベルのフォールト トレランスと QoS を確保するために使用されます。 使用可能な値を簡単に指定できるように、AksCompute.ClusterPurpose クラスが用意されています。 これらの値とそのユース ケースの詳細については、https://aka.ms/azureml-create-attach-aks を参照してください。 規定値: None
|
|
load_balancer_type
|
AKS クラスターのロード バランサーの種類。 有効な値は、PublicIp と InternalLoadBalancer です。 既定値は PublicIp です。 規定値: None
|
|
load_balancer_subnet
|
AKS クラスターのロード バランサー サブネット。 これは、内部ロード バランサーがロード バランサーの種類として使用されている場合にのみ使用できます。 既定値は aks-subnet です。 規定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
コンピューティング オブジェクトの作成時に使用される構成オブジェクト |
例外
| 型 | 説明 |
|---|---|
refresh_state
オブジェクトのプロパティのインプレース更新を実行します。
このメソッドは、対応するクラウド オブジェクトの現在の状態に基づいてプロパティを更新します。 これは主に、コンピューティング状態の手動ポーリングに使用されます。
refresh_state()例外
| 型 | 説明 |
|---|---|
serialize
この AksCompute オブジェクトを、JSON でシリアル化された辞書に変換します。
serialize()戻り値
| 型 | 説明 |
|---|---|
|
この AksCompute オブジェクトの JSON 表現。 |
例外
| 型 | 説明 |
|---|---|
update
指定された更新構成を使用して AksCompute オブジェクトを更新します。
update(update_configuration)パラメーター
| 名前 | 説明 |
|---|---|
|
update_configuration
必須
|
AKS 更新構成オブジェクト。 |
例外
| 型 | 説明 |
|---|---|