Online Deployments - List

サービス:: Machine Learning

API バージョン:: 2025-12-01

推論エンドポイントのデプロイを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments?api-version=2025-12-01

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments?api-version=2025-12-01&$orderBy={$orderBy}&$top={$top}&$skip={$skip}

URI パラメーター

名前	/	必須	型	説明
endpointName	path	True	string	オンラインエンドポイント名。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Azure Machine Learning ワークスペース名
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
$orderBy	query		string	リストの順序。
$skip	query		string	改ページ位置の継続トークン。
$top	query		integer (int32)	リストの先頭。

応答

名前	型	説明
200 OK	OnlineDeploymentTrackedResourceArmPaginatedResult	Azure 操作は正常に完了しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

List Online Deployments.

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/onlineEndpoints/testEndpointName/deployments?api-version=2025-12-01&$orderBy=string&$top=1

応答のサンプル

状態コード:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/onlineEndpoints/testEndpointName/deployments?api-version=2025-07-01-preview&$skip=2",
  "value": [
    {
      "name": "string",
      "type": "string",
      "id": "string",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-1111-2222-3333-444444444444",
        "tenantId": "00000000-1111-2222-3333-444444444444",
        "userAssignedIdentities": {
          "string": {
            "clientId": "00000000-1111-2222-3333-444444444444",
            "principalId": "00000000-1111-2222-3333-444444444444"
          }
        }
      },
      "kind": "string",
      "location": "string",
      "properties": {
        "description": "string",
        "appInsightsEnabled": false,
        "codeConfiguration": {
          "codeId": "string",
          "scoringScript": "string"
        },
        "containerResourceRequirements": {
          "containerResourceLimits": {
            "cpu": "\"1\"",
            "gpu": "\"1\"",
            "memory": "\"2Gi\""
          },
          "containerResourceRequests": {
            "cpu": "\"1\"",
            "gpu": "\"1\"",
            "memory": "\"2Gi\""
          }
        },
        "endpointComputeType": "Kubernetes",
        "environmentId": "string",
        "environmentVariables": {
          "string": "string"
        },
        "instanceType": "string",
        "livenessProbe": {
          "failureThreshold": 1,
          "initialDelay": "PT5M",
          "period": "PT5M",
          "successThreshold": 1,
          "timeout": "PT5M"
        },
        "model": "string",
        "modelMountPath": "string",
        "properties": {
          "string": "string"
        },
        "provisioningState": "Creating",
        "requestSettings": {
          "maxConcurrentRequestsPerInstance": 1,
          "maxQueueWait": "PT5M",
          "requestTimeout": "PT5M"
        },
        "scaleSettings": {
          "scaleType": "Default"
        }
      },
      "sku": {
        "name": "string",
        "capacity": 1,
        "family": "string",
        "size": "string",
        "tier": "Free"
      },
      "systemData": {
        "createdAt": "2020-01-01T12:34:56.999Z",
        "createdBy": "string",
        "createdByType": "User",
        "lastModifiedAt": "2020-01-01T12:34:56.999Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User"
      },
      "tags": {}
    }
  ]
}

定義

名前	説明
CodeConfiguration	スコアリング・コード資産の構成。
Collection
ContainerResourceRequirements	オンラインデプロイ内の各コンテナーインスタンスのリソース要件。
ContainerResourceSettings
createdByType	リソースを作成した ID の種類。
DataCollectionMode	データ収集を有効または無効にします。
DataCollector
DefaultScaleSettings
DeploymentProvisioningState	DeploymentProvisioningState に指定できる値。
EgressPublicNetworkAccessType	デプロイのエグレスに対して PublicNetworkAccess が有効か無効かを判断する列挙型。
EndpointComputeType	エンドポイントのコンピューティングの種類を決定する列挙型。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
KubernetesOnlineDeployment	KubernetesOnlineDeployment に固有のプロパティ。
ManagedOnlineDeployment	ManagedOnlineDeployment に固有のプロパティ。
ManagedServiceIdentity	マネージドサービス ID (システム割り当て ID またはユーザー割り当て ID)
ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
OnlineDeployment	具体的な追跡対象リソースの種類は、特定のプロパティ型を使用してこの型にエイリアスを設定することで作成できます。
OnlineDeploymentTrackedResourceArmPaginatedResult	OnlineDeployment エンティティのページ分割された一覧。
OnlineRequestSettings	オンライン展開スコアリング要求の構成。
ProbeSettings	デプロイコンテナーのライブネス/準備プローブの構成。
RequestLogging
RollingRateType	モデルデータが BLOB ストレージに収集される場合は、データをすべて 1 つの BLOB ファイルに記録しないように、データを別のパスにロールする必要があります。ローリングレートが時間の場合、すべてのデータが BLOB パス /yyyy/MM/dd/HH/ に収集されます。 1 日の場合、すべてのデータが BLOB パス /yyyy/MM/dd/ に収集されます。ローリングパスのもう 1 つの利点は、モデル監視 UI でデータの時間範囲を非常に迅速に選択できることです。
ScaleType
Sku	SKU を表すリソースモデル定義
SkuTier	このフィールドは、サービスに複数のレベルがあるが PUT では必要ない場合に、リソースプロバイダーによって実装される必要があります。
systemData	リソースの作成と最後の変更に関連するメタデータ。
TargetUtilizationScaleSettings
UserAssignedIdentity	ユーザー割り当て ID プロパティ

CodeConfiguration

Object

スコアリング・コード資産の構成。

名前	型	説明
codeId	string	コード資産の ARM リソース ID。
scoringScript	string minLength: 1 pattern: [a-zA-Z0-9_]	[必須]起動時に実行するスクリプト。 eg. "score.py"

Collection

Object

名前	型	規定値	説明
clientId	string		BLOB ストレージへのログ記録の収集に使用される msi クライアント ID。 null の場合、バックエンドは認証する登録済みのエンドポイント ID を選択します。
dataCollectionMode	DataCollectionMode	Disabled	データ収集を有効または無効にします。
dataId	string		データ資産の arm リソース ID。クライアント側では、データ資産が BLOB ストレージを指していることを確認し、バックエンドは BLOB ストレージにデータを収集します。
samplingRate	number (double)	1	コレクションのサンプリングレート。サンプリングレート 1.0 は、既定で 100% のデータを収集します。

ContainerResourceRequirements

Object

オンラインデプロイ内の各コンテナーインスタンスのリソース要件。

名前	型	説明
containerResourceLimits	ContainerResourceSettings	コンテナーリソースの制限情報:
containerResourceRequests	ContainerResourceSettings	コンテナーリソース要求情報:

ContainerResourceSettings

Object

名前	型	説明
cpu	string	コンテナーの vCPU 要求/制限の数。詳細情報: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
gpu	string	コンテナーの Nvidia GPU カード要求/制限の数。詳細情報: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
memory	string	コンテナーのメモリサイズ要求/制限。詳細情報: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DataCollectionMode

列挙

データ収集を有効または無効にします。

値	説明
Enabled
Disabled

DataCollector

Object

名前	型	規定値	説明
collections	<string, Collection>		[必須]コレクションの構成。各コレクションには、モデルデータを収集するための独自の構成があり、コレクションの名前は任意の文字列にすることができます。モデルデータコレクターは、ペイロードログ記録またはカスタムログ記録、またはその両方に使用できます。コレクションの要求と応答はペイロードログ用に予約され、他の要求はカスタムログ用です。
requestLogging	RequestLogging		mdc の要求ログ構成には、すべてのコレクションの詳細なログ設定が含まれています。これは省略可能です。
rollingRate	RollingRateType	Hour	モデルデータが BLOB ストレージに収集される場合は、データをすべて 1 つの BLOB ファイルに記録しないように、データを別のパスにロールする必要があります。ローリングレートが時間の場合、すべてのデータが BLOB パス /yyyy/MM/dd/HH/ に収集されます。 1 日の場合、すべてのデータが BLOB パス /yyyy/MM/dd/ に収集されます。ローリングパスのもう 1 つの利点は、モデル監視 UI でデータの時間範囲を非常に迅速に選択できることです。

DefaultScaleSettings

Object

名前	型	説明
scaleType	string: Default	[必須]デプロイスケーリングアルゴリズムの種類

DeploymentProvisioningState

列挙

DeploymentProvisioningState に指定できる値。

値	説明
Creating
Deleting
Scaling
Updating
Succeeded
Failed
Canceled

EgressPublicNetworkAccessType

列挙

デプロイのエグレスに対して PublicNetworkAccess が有効か無効かを判断する列挙型。

値	説明
Enabled
Disabled

EndpointComputeType

列挙

エンドポイントのコンピューティングの種類を決定する列挙型。

値	説明
Managed
Kubernetes
AzureMLCompute

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

KubernetesOnlineDeployment

Object

KubernetesOnlineDeployment に固有のプロパティ。

名前	型	規定値	説明
appInsightsEnabled	boolean	False	true の場合は、Application Insights のログ記録を有効にします。
codeConfiguration	CodeConfiguration		エンドポイントデプロイのコード構成。
containerResourceRequirements	ContainerResourceRequirements		コンテナーのリソース要件 (cpu とメモリ)。
dataCollector	DataCollector		mdc 構成では、mdc が null の場合は無効になります。
description	string		エンドポイントのデプロイの説明。
egressPublicNetworkAccess	EgressPublicNetworkAccessType	Enabled	デプロイのエグレスに対して PublicNetworkAccess が有効か無効かを判断する列挙型。
endpointComputeType	string: Kubernetes		[必須]エンドポイントのコンピューティングの種類。
environmentId	string		エンドポイントデプロイの環境仕様の ARM リソース ID または AssetId。
environmentVariables	object		デプロイの環境変数の構成。
instanceType	string	Standard_F4s_v2	コンピューティングインスタンスの種類。既定値: Standard_F4s_v2。
livenessProbe	ProbeSettings		Liveness プローブは、コンテナーの正常性を定期的に監視します。
model	string		モデルへの URI パス。
modelMountPath	string		カスタムコンテナーにモデルをマウントするパス。
properties	object		プロパティディクショナリ。プロパティは追加できますが、削除または変更することはできません。
provisioningState	DeploymentProvisioningState		エンドポイント展開のプロビジョニング状態。
readinessProbe	ProbeSettings		準備プローブは、コンテナーがトラフィックを処理する準備ができているかどうかを検証します。プロパティと既定値は、liveness プローブと同じです。
requestSettings	OnlineRequestSettings		デプロイの要求設定。
scaleSettings	OnlineScaleSettings: DefaultScaleSettings TargetUtilizationScaleSettings		デプロイのスケール設定。 null の場合、または指定されていない場合、KubernetesOnlineDeployment の場合は TargetUtilizationScaleSettings、ManagedOnlineDeployment の場合は DefaultScaleSettings がデフォルトになります。
startupProbe	ProbeSettings		スタートアッププローブは、コンテナー内のアプリケーションが正常に開始されたかどうかを確認します。

ManagedOnlineDeployment

Object

ManagedOnlineDeployment に固有のプロパティ。

名前	型	規定値	説明
appInsightsEnabled	boolean	False	true の場合は、Application Insights のログ記録を有効にします。
codeConfiguration	CodeConfiguration		エンドポイントデプロイのコード構成。
dataCollector	DataCollector		mdc 構成では、mdc が null の場合は無効になります。
description	string		エンドポイントのデプロイの説明。
egressPublicNetworkAccess	EgressPublicNetworkAccessType	Enabled	デプロイのエグレスに対して PublicNetworkAccess が有効か無効かを判断する列挙型。
endpointComputeType	string: Managed		[必須]エンドポイントのコンピューティングの種類。
environmentId	string		エンドポイントデプロイの環境仕様の ARM リソース ID または AssetId。
environmentVariables	object		デプロイの環境変数の構成。
instanceType	string	Standard_F4s_v2	コンピューティングインスタンスの種類。既定値: Standard_F4s_v2。
livenessProbe	ProbeSettings		Liveness プローブは、コンテナーの正常性を定期的に監視します。
model	string		モデルへの URI パス。
modelMountPath	string		カスタムコンテナーにモデルをマウントするパス。
properties	object		プロパティディクショナリ。プロパティは追加できますが、削除または変更することはできません。
provisioningState	DeploymentProvisioningState		エンドポイント展開のプロビジョニング状態。
readinessProbe	ProbeSettings		準備プローブは、コンテナーがトラフィックを処理する準備ができているかどうかを検証します。プロパティと既定値は、liveness プローブと同じです。
requestSettings	OnlineRequestSettings		デプロイの要求設定。
scaleSettings	OnlineScaleSettings: DefaultScaleSettings TargetUtilizationScaleSettings		デプロイのスケール設定。 null の場合、または指定されていない場合、KubernetesOnlineDeployment の場合は TargetUtilizationScaleSettings、ManagedOnlineDeployment の場合は DefaultScaleSettings がデフォルトになります。
startupProbe	ProbeSettings		スタートアッププローブは、コンテナー内のアプリケーションが正常に開始されたかどうかを確認します。

ManagedServiceIdentity

Object

マネージドサービス ID (システム割り当て ID またはユーザー割り当て ID)

名前	型	説明
principalId	string (uuid)	システム割り当て ID のサービスプリンシパル ID。このプロパティは、システム割り当て ID にのみ提供されます。
tenantId	string (uuid)	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID にのみ提供されます。
type	ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned ID リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリキーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。

ManagedServiceIdentityType

列挙

マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

値	説明
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned