az ml service

リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.0.28 以降) の azure-cli-ml 拡張機能の一部です。拡張機能は、 az ml service コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細をご覧ください。

運用化されたサービスを管理します。

コマンド

名前	説明	型	Status
az ml service delete	ワークスペースからサービスを削除します。	拡張子	GA
az ml service get-access-token	サービスに要求を発行するトークンを取得します。	拡張子	GA
az ml service get-keys	サービスに対して要求を発行するためのキーを取得します。	拡張子	GA
az ml service get-logs	サービスのログを取得します。	拡張子	GA
az ml service list	ワークスペース内のサービスを一覧表示します。	拡張子	GA
az ml service regen-key	サービスのキーを再生成します。	拡張子	GA
az ml service run	ワークスペースでサービスを実行します。	拡張子	GA
az ml service show	ワークスペース内のサービスの詳細を表示します。	拡張子	GA
az ml service update	ワークスペース内のサービスを更新します。	拡張子	GA

az ml service delete

ワークスペースからサービスを削除します。

az ml service delete --name
                     [--path]
                     [--resource-group]
                     [--subscription-id]
                     [--workspace-name]
                     [-v]

必須のパラメーター

--name -n

削除するサービス名。

省略可能のパラメーター

--path

プロジェクトフォルダーへのパス。既定値: 現在のディレクトリ。

--resource-group -g

指定されたワークスペースに対応するリソースグループ。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

削除するサービスを含むワークスペースの名前。

-v

詳細度フラグ。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az ml service get-access-token

サービスに要求を発行するトークンを取得します。

az ml service get-access-token --name
                               [--path]
                               [--resource-group]
                               [--subscription-id]
                               [--workspace-name]
                               [-v]

必須のパラメーター

--name -n

サービス名:

省略可能のパラメーター

--path

プロジェクトフォルダーへのパス。既定値: 現在のディレクトリ。

--resource-group -g

指定されたワークスペースに対応するリソースグループ。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

表示するサービスを含むワークスペースの名前。

-v

詳細度フラグ。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az ml service get-keys

サービスに対して要求を発行するためのキーを取得します。

az ml service get-keys --name
                       [--path]
                       [--resource-group]
                       [--subscription-id]
                       [--workspace-name]
                       [-v]

必須のパラメーター

--name -n

サービス名:

省略可能のパラメーター

--path

プロジェクトフォルダーへのパス。既定値: 現在のディレクトリ。

--resource-group -g

指定されたワークスペースに対応するリソースグループ。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

表示するサービスを含むワークスペースの名前。

-v

詳細度フラグ。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az ml service get-logs

サービスのログを取得します。

az ml service get-logs --name
                       [--init]
                       [--num_lines]
                       [--path]
                       [--resource-group]
                       [--subscription-id]
                       [--workspace-name]
                       [-v]

必須のパラメーター

--name -n

サービス名:

省略可能のパラメーター

--init -i

スコアリングコンテナーではなく、init コンテナーのログを取得します。

既定値: False

--num_lines -l

末尾から返されるログ行の数 (既定値は 5000)。

既定値: 5000

--path

プロジェクトフォルダーへのパス。既定値: 現在のディレクトリ。

--resource-group -g

指定されたワークスペースに対応するリソースグループ。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

表示するサービスを含むワークスペースの名前。

-v

詳細度フラグ。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az ml service list

ワークスペース内のサービスを一覧表示します。

az ml service list [--compute-type]
                   [--image-digest]
                   [--model-id]
                   [--model-name]
                   [--path]
                   [--property]
                   [--resource-group]
                   [--subscription-id]
                   [--tag]
                   [--workspace-name]
                   [-v]

省略可能のパラメーター

--compute-type -c

指定した場合、指定したコンピューティングの種類を持つサービスのみが表示されます。 (オプションは 'ACI'、'AKS' です)。

--image-digest

指定した場合、指定されたイメージダイジェストを持つサービスのみが表示されます。

--model-id

指定した場合、指定されたモデル ID を持つサービスのみが表示されます。

--model-name

指定した場合、指定されたモデル名を持つサービスのみが表示されます。

--path

プロジェクトフォルダーへのパス。既定値: 現在のディレクトリ。

--property

指定した場合は、指定されたキー/値 (e.g. key、または key=value) に基づいてフィルター処理されます。複数のプロパティは、複数の --property オプションで指定できます。

既定値: []

--resource-group -g

指定されたワークスペースに対応するリソースグループ。

--subscription-id

サブスクリプション ID を指定します。

--tag

指定した場合は、指定されたキー/値 (e.g. key、または key=value) に基づいてフィルター処理されます。複数のタグを複数の --tag オプションで指定できます。

既定値: []

--workspace-name -w

一覧表示するサービスを含むワークスペースの名前。

-v

詳細度フラグ。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az ml service regen-key

サービスのキーを再生成します。

az ml service regen-key --key
                        --name
                        [--path]
                        [--resource-group]
                        [--set-key]
                        [--subscription-id]
                        [--workspace-name]
                        [-v]

必須のパラメーター

--key -k

regen が指定されている場合、再生成するキー。オプション: プライマリ、セカンダリ。

--name -n

サービス名:

省略可能のパラメーター

--path

プロジェクトフォルダーへのパス。既定値: 現在のディレクトリ。

--resource-group -g

指定されたワークスペースに対応するリソースグループ。

--set-key -s

指定したキーの認証値を指定します。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

表示するサービスを含むワークスペースの名前。

-v

詳細度フラグ。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az ml service run

ワークスペースでサービスを実行します。

az ml service run --name
                  [--input-data]
                  [--path]
                  [--resource-group]
                  [--subscription-id]
                  [--workspace-name]
                  [-v]

必須のパラメーター

--name -n

スコア付け対象のサービス名。

省略可能のパラメーター

--input-data -d

Web サービスの呼び出しに使用するデータ。

--path

プロジェクトフォルダーへのパス。既定値: 現在のディレクトリ。

--resource-group -g

指定されたワークスペースに対応するリソースグループ。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

実行するサービスを含むワークスペースの名前。

-v

詳細度フラグ。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az ml service show

ワークスペース内のサービスの詳細を表示します。

az ml service show --name
                   [--path]
                   [--resource-group]
                   [--subscription-id]
                   [--workspace-name]
                   [-v]

必須のパラメーター

--name -n

表示する Web サービスの名前。

省略可能のパラメーター

--path

プロジェクトフォルダーへのパス。既定値: 現在のディレクトリ。

--resource-group -g

指定されたワークスペースに対応するリソースグループ。

--subscription-id

サブスクリプション ID を指定します。

--workspace-name -w

表示するサービスを含むワークスペースの名前。

-v

詳細度フラグ。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az ml service update

ワークスペース内のサービスを更新します。

az ml service update --name
                     [--add-property]
                     [--add-tag]
                     [--ae]
                     [--ai]
                     [--ar]
                     [--as]
                     [--at]
                     [--autoscale-max-replicas]
                     [--autoscale-min-replicas]
                     [--base-image]
                     [--base-image-registry]
                     [--cc]
                     [--ccl]
                     [--cf]
                     [--collect-model-data]
                     [--compute-target]
                     [--cuda-version]
                     [--dc]
                     [--description]
                     [--dn]
                     [--ds]
                     [--ed]
                     [--eg]
                     [--entry-script]
                     [--environment-name]
                     [--environment-version]
                     [--failure-threshold]
                     [--gb]
                     [--gbl]
                     [--gc]
                     [--ic]
                     [--id]
                     [--is-migration]
                     [--kp]
                     [--ks]
                     [--lo]
                     [--max-request-wait-time]
                     [--model]
                     [--model-metadata-file]
                     [--no-wait]
                     [--nr]
                     [--path]
                     [--period-seconds]
                     [--po]
                     [--remove-tag]
                     [--replica-max-concurrent-requests]
                     [--resource-group]
                     [--rt]
                     [--sc]
                     [--scoring-timeout-ms]
                     [--sd]
                     [--se]
                     [--sk]
                     [--sp]
                     [--st]
                     [--subscription-id]
                     [--timeout-seconds]
                     [--token-auth-enabled]
                     [--workspace-name]
                     [-v]

必須のパラメーター

--name -n

更新するサービス名。

省略可能のパラメーター

--add-property

追加するキー/値プロパティ (e.g. key=value)。複数の --add-property オプションを使用して、複数のプロパティを指定できます。

既定値: []

--add-tag

追加するキー/値タグ (e.g. key=value)。複数の --add-tag オプションを使用して、複数のタグを指定できます。

既定値: []

--ae --auth-enabled

この Webservice に対してキー認証を有効にするかどうかを指定します。既定値は False です。

--ai --enable-app-insights

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

--ar --autoscale-refresh-seconds

自動スケーラーがこの Webservice のスケーリングを試行する頻度。デフォルト値は 1 です。

--as --autoscale-enabled

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

--at --autoscale-target-utilization

自動スケーラーがこの Webservice に対して維持しようとする目標使用率 (最大 100%)。既定値は 70 です。

--autoscale-max-replicas --ma

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

--autoscale-min-replicas --mi

この Webservice を自動スケーリングするときに使用するコンテナーの最小数。デフォルト値は 1 です。

--base-image --bi

基本イメージとして使用するカスタムイメージ。基本イメージが指定されていない場合、指定されたランタイムパラメーターに基づいた基本イメージが使用されます。

--base-image-registry --ir

基本イメージを含むイメージレジストリ。

--cc --cpu-cores

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

--ccl --cpu-cores-limit

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

--cf --conda-file

イメージに使用する Conda 環境定義を含むローカルファイルのパス。

--collect-model-data --md

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

--compute-target

(プレビュー)移行された Kubernetes オンラインエンドポイントとデプロイをホストするために AzureML 拡張機能がインストールされているコンピューティング先を指定します。

--cuda-version --cv

GPU のサポートが必要なイメージにインストールする CUDA のバージョン。 GPU イメージは、Azure Container Instances、Azure Machine Learning コンピューティング、Azure Virtual Machines、Azure Kubernetes Service などの Microsoft Azure サービス上で使用する必要があります。サポートされているバージョンは 9.0、9.1、10.0 です。 "enable_gpu" が設定されている場合、これの既定値は "9.1" です。

--dc --deploy-config-file

デプロイメタデータを含む JSON ファイルへのパス。

--description -d

サービスの説明。

--dn --dns-name-label

この Web サービスの DNS 名。

--ds --extra-docker-file-steps

イメージを設定するときに実行する追加の Docker 手順を含むローカルファイルのパス。

--ed --environment-directory

デプロイ用の Azure Machine Learning Environment のディレクトリ。これは、'az ml environment scaffold' コマンドで指定されたのと同じディレクトリパスです。

--eg --enable-gpu

イメージで GPU サポートを有効にするかどうか。 GPU イメージは、Azure Container Instances、Azure Machine Learning コンピューティング、Azure Virtual Machines、Azure Kubernetes Service などの Microsoft Azure サービス上で使用する必要があります。既定値は False です。

--entry-script --es

サービス用に実行するコードを含むローカルファイルへのパス (指定されている場合はsource_directoryからの相対パス)。

--environment-name -e

デプロイ用の Azure Machine Learning 環境の名前。

--environment-version --ev

デプロイ用の既存の Azure Machine Learning 環境のバージョン。

--failure-threshold --ft

ポッドが起動し、ライブネスプローブが失敗した場合、Kubernetes は --failure-threshold 時間を試してから終了します。既定値は 3 です。最大値は 1 です。

--gb --memory-gb

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

--gbl --memory-gb-limit

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

--gc --gpu-cores

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

--ic --inference-config-file

推論構成を含む JSON または YAML ファイルへのパス。

--id --initial-delay-seconds

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

--is-migration

(プレビュー)AKS Web サービスを Kubernetes オンラインエンドポイントとデプロイに移行するかどうか。既定値は False です。

--kp --primary-key

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

--ks --secondary-key

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

--lo --location

この Web サービスのデプロイ先となる Azure リージョン。指定されていない場合、ワークスペースの場所が使用されます。利用可能なリージョンの詳細については、 https://azure.microsoft.com/en-us/global-infrastructure/services/?regions=all&を参照してください。products=container-instances。

--max-request-wait-time --mr

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

--model -m

デプロイするモデルの ID。複数のモデルを追加の -m 引数で指定できます。最初にモデルを登録する必要があります。

既定値: []

--model-metadata-file -f

モデル登録メタデータを含む JSON ファイルへのパス。複数の -f パラメーターを使用して、複数のモデルを指定できます。

既定値: []

--no-wait

非同期呼び出しを待機しないフラグ。

--nr --num-replicas

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

--path

プロジェクトフォルダーへのパス。既定値: 現在のディレクトリ。

--period-seconds --ps

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

--po --port

サービスの HTTP エンドポイントを公開するローカルポート。

--remove-tag

削除するタグのキー。複数のタグを複数の --remove-tag オプションで指定できます。

既定値: []

--replica-max-concurrent-requests --rm

この Web サービスに対して許可するノードあたりの最大同時要求数。デフォルト値は 1 です。

--resource-group -g

指定されたワークスペースに対応するリソースグループ。

--rt --runtime

イメージに使用するランタイム。現在サポートされているランタイムは、'spark-py' と 'python'spark-py|python|python-slim です。

--sc --ssl-cname

SSL が有効な場合の cname ACI サービスを更新する場合にのみ適用されます。

--scoring-timeout-ms --tm

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

--sd --source-directory

イメージを作成するためのファイルをすべて含むフォルダーのパス。

--se --ssl-enabled

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

--sk --ssl-key-pem-file

SSL が有効な場合、キーファイルが必要です。

--sp --ssl-cert-pem-file

SSL が有効な場合、証明書ファイルが必要です。

--st --success-threshold

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

--subscription-id

サブスクリプション ID を指定します。

--timeout-seconds --ts

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

--token-auth-enabled

この Web サービスのトークン認証を有効にするかどうかを指定します。 AKS Web サービスでのみ使用できます。既定値は False です。

--workspace-name -w

更新するサービスを含むワークスペースの名前。

-v

詳細度フラグ。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

az ml service

コマンド

az ml service delete

必須のパラメーター

省略可能のパラメーター

az ml service get-access-token

必須のパラメーター

省略可能のパラメーター

az ml service get-keys

必須のパラメーター

省略可能のパラメーター

az ml service get-logs

必須のパラメーター

省略可能のパラメーター

az ml service list

省略可能のパラメーター

az ml service regen-key

必須のパラメーター

省略可能のパラメーター

az ml service run

必須のパラメーター

省略可能のパラメーター

az ml service show

必須のパラメーター

省略可能のパラメーター

az ml service update

必須のパラメーター

省略可能のパラメーター

その他のリソース