Bug in validation BatchDeploymentSchema

[asos-rickbruins]

• Package Name: azure-ai-ml
• Package Version: 1.11.1
• Operating System: Linux 23.10.09
• Python Version: 3.8.10

Describe the bug
Validation error for BatchDeploymentSchema when using the field "settings". However, it is listed as a valid key in the yaml schema, see documentation

To Reproduce
Steps to reproduce the behavior:

deployment.yaml

$schema: https://azuremlschemasprod.azureedge.net/latest/batchDeployment.schema.json
name: collaborative-filtering-train
description: Train CF model and save embeddings
endpoint_name: collaborative-filtering-train
type: pipeline
component: ./pipeline.yaml
settings:
  continue_on_step_failure: false
  force_rerun: true

from azure.ai.ml import load_batch_deployment

deployment = load_batch_deployment("deployment.yaml")

Error

marshmallow.exceptions.ValidationError: {'settings': ['Unknown field.']}

Expected behavior
No error, because the key is valid.

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Add any other context about the problem here.

[github-actions]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @azureml-github @Azure/azure-ml-sdk.

[kristapratico]

@asos-rickbruins thanks for your feedback, @azureml-github will take a look and get back to you as soon as possible.

[asos-rickbruins]

Any update?

[santiagxf]

Apologies for the delay in getting back to you @asos-rickbruins. https://azuremlschemasprod.azureedge.net/latest/batchDeployment.schema.json is our legacy schema for model batch deployments. Please use https://azuremlschemas.azureedge.net/latest/pipelineComponentBatchDeployment.schema.json for pipeline component deployments. I'm updating the documentation so it reflects the right schema.

[santiagxf]

Examples has been updated in the PR: Azure/azureml-examples#2962