diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json index 0b38d274ba9c..fde24eb222f7 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json @@ -4898,7 +4898,7 @@ "type": "object", "properties": { "referenceType": { - "description": "Specifies the type of asset reference.", + "description": "[Required] Specifies the type of asset reference.", "$ref": "#/definitions/ReferenceType" } }, @@ -4943,7 +4943,7 @@ ], "properties": { "accountName": { - "description": "Storage account name.", + "description": "[Required] Storage account name.", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -4952,7 +4952,7 @@ ] }, "containerName": { - "description": "Storage account container name.", + "description": "[Required] Storage account container name.", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -4961,11 +4961,11 @@ ] }, "credentials": { - "description": "Account credentials.", + "description": "[Required] Account credentials.", "$ref": "#/definitions/DatastoreCredentials" }, "endpoint": { - "description": "Azure cloud endpoint for the storage account.", + "description": "[Required] Azure cloud endpoint for the storage account.", "pattern": "[a-zA-Z0-9_]", "type": "string", "example": "core.windows.net", @@ -4975,7 +4975,7 @@ ] }, "protocol": { - "description": "Protocol used to communicate with the storage account.", + "description": "[Required] Protocol used to communicate with the storage account.", "pattern": "[a-zA-Z0-9_]", "type": "string", "example": "https", @@ -5002,11 +5002,11 @@ ], "properties": { "credentials": { - "description": "Account credentials.", + "description": "[Required] Account credentials.", "$ref": "#/definitions/DatastoreCredentials" }, "storeName": { - "description": "Azure Data Lake store name.", + "description": "[Required] Azure Data Lake store name.", "pattern": "[a-zA-Z0-9_]", "type": "string" } @@ -5031,7 +5031,7 @@ ], "properties": { "accountName": { - "description": "Storage account name.", + "description": "[Required] Storage account name.", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -5040,7 +5040,7 @@ ] }, "containerName": { - "description": "Storage account container name.", + "description": "[Required] Storage account container name.", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -5049,11 +5049,11 @@ ] }, "credentials": { - "description": "Account credentials.", + "description": "[Required] Account credentials.", "$ref": "#/definitions/DatastoreCredentials" }, "endpoint": { - "description": "Azure cloud endpoint for the storage account.", + "description": "[Required] Azure cloud endpoint for the storage account.", "pattern": "[a-zA-Z0-9_]", "type": "string", "example": "core.windows.net", @@ -5063,7 +5063,7 @@ ] }, "protocol": { - "description": "Protocol used to communicate with the storage account.", + "description": "[Required] Protocol used to communicate with the storage account.", "pattern": "[a-zA-Z0-9_]", "type": "string", "example": "https", @@ -5093,7 +5093,7 @@ ], "properties": { "accountName": { - "description": "Storage account name.", + "description": "[Required] Storage account name.", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -5102,7 +5102,7 @@ ] }, "containerName": { - "description": "Storage account container name.", + "description": "[Required] Storage account container name.", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -5111,11 +5111,11 @@ ] }, "credentials": { - "description": "Account credentials.", + "description": "[Required] Account credentials.", "$ref": "#/definitions/DatastoreCredentials" }, "endpoint": { - "description": "Azure cloud endpoint for the storage account.", + "description": "[Required] Azure cloud endpoint for the storage account.", "pattern": "[a-zA-Z0-9_]", "type": "string", "example": "core.windows.net", @@ -5125,7 +5125,7 @@ ] }, "protocol": { - "description": "Protocol used to communicate with the storage account.", + "description": "[Required] Protocol used to communicate with the storage account.", "pattern": "[a-zA-Z0-9_]", "type": "string", "example": "https", @@ -5155,11 +5155,11 @@ ], "properties": { "credentials": { - "description": "Account credentials.", + "description": "[Required] Account credentials.", "$ref": "#/definitions/DatastoreCredentials" }, "databaseName": { - "description": "Azure SQL database name.", + "description": "[Required] Azure SQL database name.", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -5176,7 +5176,7 @@ ] }, "endpoint": { - "description": "Azure cloud endpoint for the database.", + "description": "[Required] Azure cloud endpoint for the database.", "pattern": "[a-zA-Z0-9_]", "type": "string", "example": "database.windows.net", @@ -5187,7 +5187,7 @@ }, "portNumber": { "format": "int32", - "description": "Azure SQL server port.", + "description": "[Required] Azure SQL server port.", "type": "integer", "x-ms-mutability": [ "create", @@ -5195,7 +5195,7 @@ ] }, "serverName": { - "description": "Azure SQL server name.", + "description": "[Required] Azure SQL server name.", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -5224,11 +5224,11 @@ ], "properties": { "credentials": { - "description": "Account credentials.", + "description": "[Required] Account credentials.", "$ref": "#/definitions/DatastoreCredentials" }, "databaseName": { - "description": "Azure SQL database name.", + "description": "[Required] Azure SQL database name.", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -5237,7 +5237,7 @@ ] }, "endpoint": { - "description": "Azure cloud endpoint for the database.", + "description": "[Required] Azure cloud endpoint for the database.", "pattern": "[a-zA-Z0-9_]", "type": "string", "example": "database.windows.net", @@ -5248,7 +5248,7 @@ }, "portNumber": { "format": "int32", - "description": "Azure SQL server port.", + "description": "[Required] Azure SQL server port.", "type": "integer", "x-ms-mutability": [ "create", @@ -5256,7 +5256,7 @@ ] }, "serverName": { - "description": "Azure SQL server name.", + "description": "[Required] Azure SQL server name.", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -5382,7 +5382,7 @@ "type": "string" }, "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/BatchDeployment" }, "systemData": { @@ -5419,7 +5419,7 @@ "type": "object", "properties": { "authMode": { - "description": "Enum to determine endpoint authentication mode.", + "description": "[Required] Inference endpoint authentication mode type", "$ref": "#/definitions/EndpointAuthMode" }, "description": { @@ -5491,7 +5491,7 @@ "type": "string" }, "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/BatchEndpoint" }, "systemData": { @@ -5602,7 +5602,7 @@ }, "clientId": { "format": "uuid", - "description": "Service principal client ID.", + "description": "[Required] Service principal client ID.", "type": "string" }, "resourceUri": { @@ -5620,11 +5620,11 @@ }, "tenantId": { "format": "uuid", - "description": "ID of the tenant to which the service principal belongs.", + "description": "[Required] ID of the tenant to which the service principal belongs.", "type": "string" }, "thumbprint": { - "description": "Thumbprint of the certificate used for authentication.", + "description": "[Required] Thumbprint of the certificate used for authentication.", "pattern": "[a-zA-Z0-9_]", "type": "string" } @@ -5693,7 +5693,7 @@ ] }, "scoringScript": { - "description": "The script to execute on startup. eg. \"score.py\"", + "description": "[Required] The script to execute on startup. eg. \"score.py\"", "minLength": 1, "pattern": "[a-zA-Z0-9_]", "type": "string", @@ -5743,7 +5743,7 @@ ], "properties": { "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/CodeContainer" }, "systemData": { @@ -5799,7 +5799,7 @@ ] }, "path": { - "description": "The path of the file/directory in the datastore.", + "description": "[Required] The path of the file/directory in the datastore.", "pattern": "[a-zA-Z0-9_]", "type": "string" }, @@ -5833,7 +5833,7 @@ ], "properties": { "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/CodeVersion" }, "systemData": { @@ -5887,7 +5887,7 @@ ] }, "command": { - "description": "The command to execute on startup of the job. eg. \"python train.py\"", + "description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"", "minLength": 1, "pattern": "[a-zA-Z0-9_]", "type": "string", @@ -5897,7 +5897,7 @@ ] }, "compute": { - "description": "Compute binding for the job.", + "description": "[Required] Compute binding for the job.", "$ref": "#/definitions/ComputeConfiguration", "x-ms-mutability": [ "create", @@ -6057,7 +6057,7 @@ } }, "target": { - "description": "ARM resource ID of the compute resource.", + "description": "ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed.", "type": "string", "x-ms-mutability": [ "create", @@ -6195,7 +6195,7 @@ ], "properties": { "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/DataContainer" }, "systemData": { @@ -6276,7 +6276,7 @@ ] }, "path": { - "description": "The path of the file/directory in the datastore.", + "description": "[Required] The path of the file/directory in the datastore.", "pattern": "[a-zA-Z0-9_]", "type": "string" }, @@ -6310,7 +6310,7 @@ ], "properties": { "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/DataVersion" }, "systemData": { @@ -6382,7 +6382,7 @@ "type": "object", "properties": { "contentsType": { - "description": "Storage type backing the datastore.", + "description": "[Required] Storage type backing the datastore.", "$ref": "#/definitions/ContentsType" } }, @@ -6396,7 +6396,7 @@ "type": "object", "properties": { "credentialsType": { - "description": "Credential type used to authentication with storage.", + "description": "[Required] Credential type used to authentication with storage.", "$ref": "#/definitions/CredentialsType" } }, @@ -6410,7 +6410,7 @@ "type": "object", "properties": { "contents": { - "description": "Reference to the datastore storage contents.", + "description": "[Required] Reference to the datastore storage contents.", "$ref": "#/definitions/DatastoreContents" }, "description": { @@ -6463,7 +6463,7 @@ ], "properties": { "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/DatastoreProperties" }, "systemData": { @@ -6503,7 +6503,7 @@ "type": "object", "properties": { "secretsType": { - "description": "Credential type used to authentication with storage.", + "description": "[Required] Credential type used to authentication with storage.", "$ref": "#/definitions/SecretsType" } }, @@ -6559,7 +6559,7 @@ "type": "object", "properties": { "distributionType": { - "description": "Specifies the type of distribution framework.", + "description": "[Required] Specifies the type of distribution framework.", "$ref": "#/definitions/DistributionType", "x-ms-mutability": [ "create", @@ -6604,7 +6604,7 @@ ] }, "dockerfile": { - "description": "Docker command line instructions to assemble an image.\r\n", + "description": "[Required] Docker command line instructions to assemble an image.\r\n", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -6629,7 +6629,7 @@ ], "properties": { "dockerImageUri": { - "description": "Image name of a custom base image.\r\n", + "description": "[Required] Image name of a custom base image.\r\n", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -6659,7 +6659,7 @@ "type": "object", "properties": { "dockerSpecificationType": { - "description": "Docker specification must be either Build or Image", + "description": "[Required] Docker specification must be either Build or Image", "$ref": "#/definitions/DockerSpecificationType", "x-ms-mutability": [ "create", @@ -6708,7 +6708,7 @@ "type": "integer" }, "policyType": { - "description": "Name of policy configuration", + "description": "[Required] Name of policy configuration", "$ref": "#/definitions/EarlyTerminationPolicyType" } }, @@ -6858,7 +6858,7 @@ ], "properties": { "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/EnvironmentContainer" }, "systemData": { @@ -6969,7 +6969,7 @@ ], "properties": { "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/EnvironmentSpecificationVersion" }, "systemData": { @@ -7040,7 +7040,7 @@ ] }, "format": { - "description": "The format of exported labels, also as the discriminator.", + "description": "[Required] The format of exported labels, also as the discriminator.", "$ref": "#/definitions/ExportFormatType", "x-ms-mutability": [ "create", @@ -7094,7 +7094,7 @@ ], "properties": { "serverAddress": { - "description": "GlusterFS server address (can be the IP address or server name).", + "description": "[Required] GlusterFS server address (can be the IP address or server name).", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -7103,7 +7103,7 @@ ] }, "volumeName": { - "description": "GlusterFS volume name.", + "description": "[Required] GlusterFS volume name.", "pattern": "[a-zA-Z0-9_]", "type": "string", "x-ms-mutability": [ @@ -7141,7 +7141,7 @@ ], "properties": { "assetId": { - "description": "ARM resource ID of the asset.", + "description": "[Required] ARM resource ID of the asset.", "pattern": "[a-zA-Z0-9_]", "type": "string" } @@ -7157,7 +7157,7 @@ "type": "object", "properties": { "identityType": { - "description": "Specifies the type of identity framework.", + "description": "[Required] Specifies the type of identity framework.", "$ref": "#/definitions/IdentityConfigurationType", "x-ms-mutability": [ "create", @@ -7265,7 +7265,7 @@ ] }, "jobType": { - "description": "Specifies the type of job.", + "description": "[Required] Specifies the type of job.", "$ref": "#/definitions/JobType", "x-ms-mutability": [ "create", @@ -7310,7 +7310,7 @@ ], "properties": { "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/JobBase" }, "systemData": { @@ -7629,7 +7629,7 @@ ] }, "jobType": { - "description": "Specifies the type of job. This field should always be set to \"Labeling\".", + "description": "[Required] Specifies the type of job. This field should always be set to \"Labeling\".", "$ref": "#/definitions/JobType", "x-ms-mutability": [ "create", @@ -7766,7 +7766,7 @@ "type": "object", "properties": { "mediaType": { - "description": "Media type of the job.", + "description": "[Required] Media type of the job.", "$ref": "#/definitions/MediaType", "x-ms-mutability": [ "create", @@ -7789,7 +7789,7 @@ ], "properties": { "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/LabelingJob" }, "systemData": { @@ -8031,7 +8031,7 @@ ], "properties": { "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/ModelContainer" }, "systemData": { @@ -8094,7 +8094,7 @@ ] }, "path": { - "description": "The path of the file/directory in the datastore.", + "description": "[Required] The path of the file/directory in the datastore.", "pattern": "[a-zA-Z0-9_]", "type": "string" }, @@ -8128,7 +8128,7 @@ ], "properties": { "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/ModelVersion" }, "systemData": { @@ -8224,11 +8224,11 @@ "type": "object", "properties": { "goal": { - "description": "Defines supported metric goals for hyperparameter tuning", + "description": "[Required] Defines supported metric goals for hyperparameter tuning", "$ref": "#/definitions/Goal" }, "primaryMetric": { - "description": "Name of the metric to optimize.", + "description": "[Required] Name of the metric to optimize.", "pattern": "[a-zA-Z0-9_]", "type": "string" } @@ -8254,7 +8254,7 @@ "type": "string" }, "endpointComputeType": { - "description": "The compute type of the endpoint.", + "description": "[Required] The compute type of the endpoint.", "$ref": "#/definitions/EndpointComputeType" }, "environmentId": { @@ -8323,7 +8323,7 @@ "type": "string" }, "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/OnlineDeployment" }, "systemData": { @@ -8363,7 +8363,7 @@ "type": "object", "properties": { "authMode": { - "description": "Inference endpoint authentication mode type", + "description": "[Required] Inference endpoint authentication mode type", "$ref": "#/definitions/EndpointAuthMode" }, "description": { @@ -8447,7 +8447,7 @@ "type": "string" }, "properties": { - "description": "Additional attributes of the entity.", + "description": "[Required] Additional attributes of the entity.", "$ref": "#/definitions/OnlineEndpoint" }, "systemData": { @@ -8519,7 +8519,7 @@ "type": "integer" }, "scaleType": { - "description": "Type of deployment scaling algorithm", + "description": "[Required] Type of deployment scaling algorithm", "$ref": "#/definitions/ScaleType" } }, @@ -8753,7 +8753,7 @@ "type": "boolean" }, "endpointComputeType": { - "description": "The compute type of the endpoint.", + "description": "[Required] The compute type of the endpoint.", "$ref": "#/definitions/EndpointComputeType" }, "livenessProbe": { @@ -8960,7 +8960,7 @@ "type": "object", "properties": { "keyType": { - "description": "Specification for which type of key to generate. Primary or Secondary.", + "description": "[Required] Specification for which type of key to generate. Primary or Secondary.", "$ref": "#/definitions/KeyType" }, "keyValue": { @@ -9027,13 +9027,13 @@ "type": "object", "properties": { "path": { - "description": "The path for the route.", + "description": "[Required] The path for the route.", "pattern": "[a-zA-Z0-9_]", "type": "string" }, "port": { "format": "int32", - "description": "The port for the route.", + "description": "[Required] The port for the route.", "type": "integer" } }, @@ -9139,7 +9139,7 @@ }, "clientId": { "format": "uuid", - "description": "Service principal client ID.", + "description": "[Required] Service principal client ID.", "type": "string" }, "resourceUri": { @@ -9157,7 +9157,7 @@ }, "tenantId": { "format": "uuid", - "description": "ID of the tenant to which the service principal belongs.", + "description": "[Required] ID of the tenant to which the service principal belongs.", "type": "string" } }, @@ -9203,7 +9203,7 @@ "x-ms-secret": true }, "userId": { - "description": "SQL database user name.", + "description": "[Required] SQL database user name.", "pattern": "[a-zA-Z0-9_]", "type": "string" } @@ -9297,11 +9297,11 @@ ], "properties": { "algorithm": { - "description": "Type of the hyperparameter sampling algorithms", + "description": "[Required] Type of the hyperparameter sampling algorithms", "$ref": "#/definitions/SamplingAlgorithm" }, "compute": { - "description": "Compute binding for the job.", + "description": "[Required] Compute binding for the job.", "$ref": "#/definitions/ComputeConfiguration", "x-ms-mutability": [ "create", @@ -9339,7 +9339,7 @@ "type": "integer" }, "objective": { - "description": "Optimization objective.", + "description": "[Required] Optimization objective.", "$ref": "#/definitions/Objective" }, "output": { @@ -9360,7 +9360,7 @@ ] }, "searchSpace": { - "description": "A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter", + "description": "[Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter", "type": "object", "additionalProperties": { "type": "object" @@ -9446,7 +9446,7 @@ ] }, "command": { - "description": "The command to execute on startup of the job. eg. \"python train.py\"", + "description": "[Required] The command to execute on startup of the job. eg. \"python train.py\"", "minLength": 1, "pattern": "[a-zA-Z0-9_]", "type": "string",