adding allowed_instance_types and Schema shortlink (#44387)

* adding allowed_instance_types and Schema shortlink

* pylint fix and changelog update

* changelog update

Author: kshitij-microsoft

sdk/ml/azure-ai-ml/CHANGELOG.md

@@ -14,6 +14,7 @@
 - Ensuring that azureml-dataprep-rslex is only installed for PyPy below 3.10 and CPython below 3.13.
 - Adding support for Python 3.14.
 - Dropping support for Python 3.7 and 3.8.
+- Update the deployment template parameter `allowed_instance_type` -> `allowed_instance_types`
 
 ## 1.30.0 (2025-10-29)
 
@@ -40,10 +41,12 @@
   - `ml_client.deployment_templates.restore()`
 
 ### Bugs Fixed
+
 - Fix for registry resource group passed to OnlineEndpointOperations when model is in registry in different resource group compared to workspace.
 - Set defaults for min_instances, max_instances, idle_time_before_scale_down in AmlCompute
 
 ### Other Changes
+
 - v2 component types are now case insensitive
 
 ## 1.28.1 (2025-07-08)
@@ -767,4 +770,4 @@
 
 ### Features Added
 
-- First preview.
+- First preview.

sdk/ml/azure-ai-ml/azure/ai/ml/_restclient/v2024_04_01_dataplanepreview/models/_models.py

@@ -228,8 +228,8 @@ class DeploymentTemplate(msrest.serialization.Model):
     :vartype liveness_probe: ~azure.mgmt.machinelearningservices.models.ProbeSettings
     :ivar readiness_probe: Readiness probe settings.
     :vartype readiness_probe: ~azure.mgmt.machinelearningservices.models.ProbeSettings
-    :ivar allowed_instance_type: Required. List of allowed instance types for the deployment.
-    :vartype allowed_instance_type: list[str]
+    :ivar allowed_instance_types: Required. List of allowed instance types for the deployment.
+    :vartype allowed_instance_types: list[str]
     :ivar default_instance_type: Required. Default instance type for the deployment.
     :vartype default_instance_type: str
     :ivar instance_count: Required. Number of instances for the deployment.
@@ -245,7 +245,7 @@ class DeploymentTemplate(msrest.serialization.Model):
         'system_data': {'readonly': True},
         'deployment_template_type': {'required': True},
         'environment_id': {'required': True},
-        'allowed_instance_type': {'required': True},
+        'allowed_instance_types': {'required': True},
         'default_instance_type': {'required': True},
         'instance_count': {'required': True},
     }
@@ -265,7 +265,7 @@ class DeploymentTemplate(msrest.serialization.Model):
         'request_settings': {'key': 'requestSettings', 'type': 'OnlineRequestSettings'},
         'liveness_probe': {'key': 'livenessProbe', 'type': 'ProbeSettings'},
         'readiness_probe': {'key': 'readinessProbe', 'type': 'ProbeSettings'},
-        'allowed_instance_type': {'key': 'allowedInstanceType', 'type': '[str]'},
+        'allowed_instance_types': {'key': 'allowedInstanceTypes', 'type': '[str]'},
         'default_instance_type': {'key': 'defaultInstanceType', 'type': 'str'},
         'instance_count': {'key': 'instanceCount', 'type': 'int'},
         'scoring_path': {'key': 'scoringPath', 'type': 'str'},
@@ -304,8 +304,8 @@ def __init__(
         :paramtype liveness_probe: ~azure.mgmt.machinelearningservices.models.ProbeSettings
         :keyword readiness_probe: Readiness probe settings.
         :paramtype readiness_probe: ~azure.mgmt.machinelearningservices.models.ProbeSettings
-        :keyword allowed_instance_type: Required. List of allowed instance types for the deployment.
-        :paramtype allowed_instance_type: list[str]
+        :keyword allowed_instance_types: Required. List of allowed instance types for the deployment.
+        :paramtype allowed_instance_types: list[str]
         :keyword default_instance_type: Required. Default instance type for the deployment.
         :paramtype default_instance_type: str
         :keyword instance_count: Required. Number of instances for the deployment.
@@ -330,7 +330,7 @@ def __init__(
         self.request_settings = kwargs.get('request_settings', None)
         self.liveness_probe = kwargs.get('liveness_probe', None)
         self.readiness_probe = kwargs.get('readiness_probe', None)
-        self.allowed_instance_type = kwargs['allowed_instance_type']
+        self.allowed_instance_types = kwargs['allowed_instance_types']
         self.default_instance_type = kwargs['default_instance_type']
         self.instance_count = kwargs['instance_count']
         self.scoring_path = kwargs.get('scoring_path', None)

sdk/ml/azure-ai-ml/azure/ai/ml/_restclient/v2024_04_01_dataplanepreview/models/_models_py3.py

@@ -247,8 +247,8 @@ class DeploymentTemplate(msrest.serialization.Model):
     :vartype liveness_probe: ~azure.mgmt.machinelearningservices.models.ProbeSettings
     :ivar readiness_probe: Readiness probe settings.
     :vartype readiness_probe: ~azure.mgmt.machinelearningservices.models.ProbeSettings
-    :ivar allowed_instance_type: Required. List of allowed instance types for the deployment.
-    :vartype allowed_instance_type: list[str]
+    :ivar allowed_instance_types: Required. List of allowed instance types for the deployment.
+    :vartype allowed_instance_types: list[str]
     :ivar default_instance_type: Required. Default instance type for the deployment.
     :vartype default_instance_type: str
     :ivar instance_count: Required. Number of instances for the deployment.
@@ -264,7 +264,7 @@ class DeploymentTemplate(msrest.serialization.Model):
         'system_data': {'readonly': True},
         'deployment_template_type': {'required': True},
         'environment_id': {'required': True},
-        'allowed_instance_type': {'required': True},
+        'allowed_instance_types': {'required': True},
         'default_instance_type': {'required': True},
         'instance_count': {'required': True},
     }
@@ -284,7 +284,7 @@ class DeploymentTemplate(msrest.serialization.Model):
         'request_settings': {'key': 'requestSettings', 'type': 'OnlineRequestSettings'},
         'liveness_probe': {'key': 'livenessProbe', 'type': 'ProbeSettings'},
         'readiness_probe': {'key': 'readinessProbe', 'type': 'ProbeSettings'},
-        'allowed_instance_type': {'key': 'allowedInstanceType', 'type': '[str]'},
+        'allowed_instance_types': {'key': 'allowedInstanceTypes', 'type': '[str]'},
         'default_instance_type': {'key': 'defaultInstanceType', 'type': 'str'},
         'instance_count': {'key': 'instanceCount', 'type': 'int'},
         'scoring_path': {'key': 'scoringPath', 'type': 'str'},
@@ -296,7 +296,7 @@ def __init__(
         *,
         deployment_template_type: str,
         environment_id: str,
-        allowed_instance_type: List[str],
+        allowed_instance_types: List[str],
         default_instance_type: str,
         instance_count: int,
         stage: Optional[str] = "Development",
@@ -341,8 +341,8 @@ def __init__(
         :paramtype liveness_probe: ~azure.mgmt.machinelearningservices.models.ProbeSettings
         :keyword readiness_probe: Readiness probe settings.
         :paramtype readiness_probe: ~azure.mgmt.machinelearningservices.models.ProbeSettings
-        :keyword allowed_instance_type: Required. List of allowed instance types for the deployment.
-        :paramtype allowed_instance_type: list[str]
+        :keyword allowed_instance_types: Required. List of allowed instance types for the deployment.
+        :paramtype allowed_instance_types: list[str]
         :keyword default_instance_type: Required. Default instance type for the deployment.
         :paramtype default_instance_type: str
         :keyword instance_count: Required. Number of instances for the deployment.
@@ -367,7 +367,7 @@ def __init__(
         self.request_settings = request_settings
         self.liveness_probe = liveness_probe
         self.readiness_probe = readiness_probe
-        self.allowed_instance_type = allowed_instance_type
+        self.allowed_instance_types = allowed_instance_types
         self.default_instance_type = default_instance_type
         self.instance_count = instance_count
         self.scoring_path = scoring_path

sdk/ml/azure-ai-ml/azure/ai/ml/_schema/_deployment/template/deployment_template.py

@@ -44,7 +44,7 @@ class DeploymentTemplateSchema(PathAwareSchema):
     readiness_probe = NestedField(ProbeSettingsSchema)
     instance_count = fields.Int()
     model_mount_path = fields.Str()
-    allowed_instance_type = fields.Str()
+    allowed_instance_types = fields.Str()
     default_instance_type = fields.Str()
     environment = UnionField(
         [

sdk/ml/azure-ai-ml/azure/ai/ml/constants/_common.py

@@ -532,6 +532,7 @@ class YAMLRefDocLinks:
     FEATURE_STORE_ENTITY = "https://aka.ms/ml-cli-v2-featurestore-entity-yaml-reference"
     HUB = "https://aka.ms/ml-cli-v2-workspace-hub-entity-yaml-reference"
     CAPABILITY_HOST = "https://aka.ms/ml-cli-v2-capability-host-yaml-reference"
+    DEPLOYMENT_TEMPLATE = "https://aka.ms/ml-cli-v2-deployment-template-yaml-reference"
 
 
 class YAMLRefDocSchemaNames:
@@ -588,6 +589,8 @@ class YAMLRefDocSchemaNames:
     """Job Schedule."""
     CAPABILITY_HOST = "CapabilityHost"
     """Capability host."""
+    DEPLOYMENT_TEMPLATE = "DeploymentTemplate"
+    """Deployment template."""
 
 
 class DockerTypes:

sdk/ml/azure-ai-ml/azure/ai/ml/entities/_deployment/deployment_template.py

@@ -69,7 +69,7 @@ def __init__(  # pylint: disable=too-many-locals
         code_configuration: Optional[Dict[str, Any]] = None,
         environment_variables: Optional[Dict[str, str]] = None,
         app_insights_enabled: Optional[bool] = None,
-        allowed_instance_type: Optional[str] = None,
+        allowed_instance_types: Optional[str] = None,
         default_instance_type: Optional[str] = None,  # Handle default instance type
         scoring_port: Optional[int] = None,
         scoring_path: Optional[str] = None,
@@ -99,7 +99,7 @@ def __init__(  # pylint: disable=too-many-locals
         self.code_configuration = code_configuration
         self.environment_variables = environment_variables
         self.app_insights_enabled = app_insights_enabled
-        self.allowed_instance_type = allowed_instance_type
+        self.allowed_instance_types = allowed_instance_types
         self.default_instance_type = default_instance_type
         self.scoring_port = scoring_port
         self.scoring_path = scoring_path
@@ -362,7 +362,9 @@ def get_value(source, key, default=None):
         )
 
         # Extract additional fields
-        allowed_instance_type = get_value(properties, "allowedInstanceType") or get_value(obj, "allowed_instance_type")
+        allowed_instance_types = get_value(properties, "allowedInstanceTypes") or get_value(
+            obj, "allowed_instance_types"
+        )
         scoring_port = get_value(properties, "scoringPort") or get_value(obj, "scoring_port")
         scoring_path = get_value(properties, "scoringPath") or get_value(obj, "scoring_path")
         model_mount_path = get_value(properties, "modelMountPath") or get_value(obj, "model_mount_path")
@@ -387,12 +389,12 @@ def get_value(source, key, default=None):
             except (ValueError, SyntaxError):
                 environment_variables = {}
 
-        # Parse allowed_instance_type if it's a string
-        if isinstance(allowed_instance_type, str):
+        # Parse allowed_instance_types if it's a string
+        if isinstance(allowed_instance_types, str):
             try:
-                allowed_instance_type = ast.literal_eval(allowed_instance_type)
+                allowed_instance_types = ast.literal_eval(allowed_instance_types)
             except (ValueError, SyntaxError):
-                allowed_instance_type = None
+                allowed_instance_types = None
 
         # Convert request_settings to OnlineRequestSettings object using the built-in conversion method
         request_settings_obj = OnlineRequestSettings._from_rest_object(request_settings) if request_settings else None
@@ -434,7 +436,7 @@ def get_value(source, key, default=None):
             environment_variables=environment_variables,
             app_insights_enabled=get_value(obj, "app_insights_enabled"),  # May not be present in this API format
             deployment_template_type=deployment_template_type,  # Include deployment template type
-            allowed_instance_type=allowed_instance_type,  # Include allowed instance types
+            allowed_instance_types=allowed_instance_types,  # Include allowed instance types
             scoring_port=scoring_port,  # Include scoring port
             scoring_path=scoring_path,  # Include scoring path
             model_mount_path=model_mount_path,  # Include model mount path
@@ -466,7 +468,7 @@ def get_value(source, key, default=None):
             "code_configuration": get_value(obj, "code_configuration"),
             "app_insights_enabled": get_value(obj, "app_insights_enabled"),
             "deployment_template_type": deployment_template_type,
-            "allowed_instance_type": allowed_instance_type,
+            "allowed_instance_types": allowed_instance_types,
             "scoring_port": scoring_port,
             "scoring_path": scoring_path,
             "model_mount_path": model_mount_path,
@@ -564,15 +566,15 @@ def _to_rest_object(self) -> dict:
             result["appInsightsEnabled"] = self.app_insights_enabled  # type: ignore
 
         # Handle allowed instance types - convert string to array format for API
-        if hasattr(self, "allowed_instance_type") and self.allowed_instance_type:
-            if isinstance(self.allowed_instance_type, str):
+        if hasattr(self, "allowed_instance_types") and self.allowed_instance_types:
+            if isinstance(self.allowed_instance_types, str):
                 # Convert space-separated string to array
-                instance_types_array = self.allowed_instance_type.split()
-            elif isinstance(self.allowed_instance_type, list):
-                instance_types_array = self.allowed_instance_type
+                instance_types_array = self.allowed_instance_types.split()
+            elif isinstance(self.allowed_instance_types, list):
+                instance_types_array = self.allowed_instance_types
             else:
-                instance_types_array = [str(self.allowed_instance_type)]
-            result["allowedInstanceType"] = instance_types_array  # type: ignore[assignment]
+                instance_types_array = [str(self.allowed_instance_types)]
+            result["allowedInstanceTypes"] = instance_types_array  # type: ignore[assignment]
 
         return result
 
@@ -637,8 +639,8 @@ def _to_dict(self) -> Dict:
                 result["readinessProbe"] = readiness_dict  # type: ignore[assignment]
 
         # Add instance configuration
-        if hasattr(self, "allowed_instance_type") and self.allowed_instance_type:
-            result["allowedInstanceType"] = self.allowed_instance_type  # type: ignore[assignment]
+        if hasattr(self, "allowed_instance_types") and self.allowed_instance_types:
+            result["allowedInstanceTypes"] = self.allowed_instance_types  # type: ignore[assignment]
         if self.default_instance_type:
             result["defaultInstanceType"] = self.default_instance_type
         elif self.instance_type: