Microsoft.MachineLearningServices (preview:2025-01-01)

2025/03/11 • 10 updated methods

RegistryEnvironmentVersions_List (updated)
Description List versions.
Reference Link ¶

⚶ Changes

{
  "#id": "RegistryEnvironmentVersions_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "inferenceConfig": [
                  {
                    "@added_27823bc14e3940819b84c55f8d46c7f6": {
                      "#name": "startupRoute",
                      "Description": "The route to check the startup of the application in the container.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "path",
                          "Description": "[Required] The path for the route.",
                          "Required": true,
                          "Type": "string"
                        },
                        {
                          "#name": "port",
                          "Description": "[Required] The port for the route.",
                          "Format": "int32",
                          "Required": true,
                          "Type": "integer"
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions
{
subscriptionId: string ,
resourceGroupName: string ,
registryName: string ,
environmentName: string ,
api-version: string ,
$orderBy: string ,
$top: integer ,
$skip: string ,
listViewType: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
properties:
{
autoRebuild: enum ,
build:
{
contextUri: string ,
dockerfilePath: string ,
}
,
condaFile: string ,
environmentType: enum ,
image: string ,
imageDetails:
{
exists: boolean ,
image:
{
digest: string ,
hostname: string ,
repository: string ,
tag: string ,
}
,
vulnerabilityFindings:
{
assetId: string ,
criticalFindingsCount: integer ,
data:
[
{
cve: string ,
cveUrl: string ,
dueDate: string ,
id: string ,
packageDetails:
[
{
installPath: string ,
installedVersion: string ,
name: string ,
patchedVersion: string ,
}
,
]
,
patchable: boolean ,
providerId: string ,
publishDate: string ,
risk: enum ,
solution: string ,
title: string ,
vendorId: string ,
vendorUrl: string ,
}
,
]
,
generatedTime: string ,
highFindingsCount: integer ,
lastScanDate: string ,
scanner: string ,
source: string ,
totalFindingsCount: integer ,
}
,
}
,
inferenceConfig:
{
livenessRoute:
{
path: string ,
port: integer ,
}
,
readinessRoute:
{
path: string ,
port: integer ,
}
,
startupRoute:
{
path: string ,
port: integer ,
}
,
scoringRoute:
{
path: string ,
port: integer ,
}
,
}
,
osType: enum ,
provisioningState: enum ,
stage: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RegistryEnvironmentVersions_Get (updated)
Description Get version.
Reference Link ¶

⚶ Changes

{
  "#id": "RegistryEnvironmentVersions_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "inferenceConfig": [
              {
                "@added_5b723a112dac40b68e2aaee2cf098826": {
                  "#name": "startupRoute",
                  "Description": "The route to check the startup of the application in the container.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "path",
                      "Description": "[Required] The path for the route.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "port",
                      "Description": "[Required] The port for the route.",
                      "Format": "int32",
                      "Required": true,
                      "Type": "integer"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}
{
subscriptionId: string ,
resourceGroupName: string ,
registryName: string ,
environmentName: string ,
version: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
autoRebuild: enum ,
build:
{
contextUri: string ,
dockerfilePath: string ,
}
,
condaFile: string ,
environmentType: enum ,
image: string ,
imageDetails:
{
exists: boolean ,
image:
{
digest: string ,
hostname: string ,
repository: string ,
tag: string ,
}
,
vulnerabilityFindings:
{
assetId: string ,
criticalFindingsCount: integer ,
data:
[
{
cve: string ,
cveUrl: string ,
dueDate: string ,
id: string ,
packageDetails:
[
{
installPath: string ,
installedVersion: string ,
name: string ,
patchedVersion: string ,
}
,
]
,
patchable: boolean ,
providerId: string ,
publishDate: string ,
risk: enum ,
solution: string ,
title: string ,
vendorId: string ,
vendorUrl: string ,
}
,
]
,
generatedTime: string ,
highFindingsCount: integer ,
lastScanDate: string ,
scanner: string ,
source: string ,
totalFindingsCount: integer ,
}
,
}
,
inferenceConfig:
{
livenessRoute:
{
path: string ,
port: integer ,
}
,
readinessRoute:
{
path: string ,
port: integer ,
}
,
startupRoute:
{
path: string ,
port: integer ,
}
,
scoringRoute:
{
path: string ,
port: integer ,
}
,
}
,
osType: enum ,
provisioningState: enum ,
stage: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
RegistryEnvironmentVersions_CreateOrUpdate (updated)
Description Create or update version.
Reference Link ¶

⚶ Changes

{
  "#id": "RegistryEnvironmentVersions_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "inferenceConfig": [
              {
                "@added_ea057588958140e286be95874ab21a94": {
                  "#name": "startupRoute",
                  "Description": "The route to check the startup of the application in the container.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "path",
                      "Description": "[Required] The path for the route.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "port",
                      "Description": "[Required] The port for the route.",
                      "Format": "int32",
                      "Required": true,
                      "Type": "integer"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "inferenceConfig": [
              {
                "@added_ec2a7622ff1e448f9d94c8dc2ab7c88b": {
                  "#name": "startupRoute",
                  "Description": "The route to check the startup of the application in the container.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "path",
                      "Description": "[Required] The path for the route.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "port",
                      "Description": "[Required] The port for the route.",
                      "Format": "int32",
                      "Required": true,
                      "Type": "integer"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "inferenceConfig": [
              {
                "@added_9fa3d3f473be430899bc80efe895d865": {
                  "#name": "startupRoute",
                  "Description": "The route to check the startup of the application in the container.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "path",
                      "Description": "[Required] The path for the route.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "port",
                      "Description": "[Required] The port for the route.",
                      "Format": "int32",
                      "Required": true,
                      "Type": "integer"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}
{
subscriptionId: string ,
resourceGroupName: string ,
registryName: string ,
environmentName: string ,
version: string ,
api-version: string ,
body:
{
properties:
{
autoRebuild: enum ,
build:
{
contextUri: string ,
dockerfilePath: string ,
}
,
condaFile: string ,
environmentType: enum ,
image: string ,
imageDetails:
{
exists: boolean ,
image:
{
digest: string ,
hostname: string ,
repository: string ,
tag: string ,
}
,
vulnerabilityFindings:
{
assetId: string ,
criticalFindingsCount: integer ,
data:
[
{
cve: string ,
cveUrl: string ,
dueDate: string ,
id: string ,
packageDetails:
[
{
installPath: string ,
installedVersion: string ,
name: string ,
patchedVersion: string ,
}
,
]
,
patchable: boolean ,
providerId: string ,
publishDate: string ,
risk: enum ,
solution: string ,
title: string ,
vendorId: string ,
vendorUrl: string ,
}
,
]
,
generatedTime: string ,
highFindingsCount: integer ,
lastScanDate: string ,
scanner: string ,
source: string ,
totalFindingsCount: integer ,
}
,
}
,
inferenceConfig:
{
livenessRoute:
{
path: string ,
port: integer ,
}
,
readinessRoute:
{
path: string ,
port: integer ,
}
,
startupRoute:
{
path: string ,
port: integer ,
}
,
scoringRoute:
{
path: string ,
port: integer ,
}
,
}
,
osType: enum ,
provisioningState: enum ,
stage: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
autoRebuild: enum ,
build:
{
contextUri: string ,
dockerfilePath: string ,
}
,
condaFile: string ,
environmentType: enum ,
image: string ,
imageDetails:
{
exists: boolean ,
image:
{
digest: string ,
hostname: string ,
repository: string ,
tag: string ,
}
,
vulnerabilityFindings:
{
assetId: string ,
criticalFindingsCount: integer ,
data:
[
{
cve: string ,
cveUrl: string ,
dueDate: string ,
id: string ,
packageDetails:
[
{
installPath: string ,
installedVersion: string ,
name: string ,
patchedVersion: string ,
}
,
]
,
patchable: boolean ,
providerId: string ,
publishDate: string ,
risk: enum ,
solution: string ,
title: string ,
vendorId: string ,
vendorUrl: string ,
}
,
]
,
generatedTime: string ,
highFindingsCount: integer ,
lastScanDate: string ,
scanner: string ,
source: string ,
totalFindingsCount: integer ,
}
,
}
,
inferenceConfig:
{
livenessRoute:
{
path: string ,
port: integer ,
}
,
readinessRoute:
{
path: string ,
port: integer ,
}
,
startupRoute:
{
path: string ,
port: integer ,
}
,
scoringRoute:
{
path: string ,
port: integer ,
}
,
}
,
osType: enum ,
provisioningState: enum ,
stage: string ,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-async-operation-timeout: string ,
azure-asyncoperation: string ,
}
,
$schema:
{
properties:
{
autoRebuild: enum ,
build:
{
contextUri: string ,
dockerfilePath: string ,
}
,
condaFile: string ,
environmentType: enum ,
image: string ,
imageDetails:
{
exists: boolean ,
image:
{
digest: string ,
hostname: string ,
repository: string ,
tag: string ,
}
,
vulnerabilityFindings:
{
assetId: string ,
criticalFindingsCount: integer ,
data:
[
{
cve: string ,
cveUrl: string ,
dueDate: string ,
id: string ,
packageDetails:
[
{
installPath: string ,
installedVersion: string ,
name: string ,
patchedVersion: string ,
}
,
]
,
patchable: boolean ,
providerId: string ,
publishDate: string ,
risk: enum ,
solution: string ,
title: string ,
vendorId: string ,
vendorUrl: string ,
}
,
]
,
generatedTime: string ,
highFindingsCount: integer ,
lastScanDate: string ,
scanner: string ,
source: string ,
totalFindingsCount: integer ,
}
,
}
,
inferenceConfig:
{
livenessRoute:
{
path: string ,
port: integer ,
}
,
readinessRoute:
{
path: string ,
port: integer ,
}
,
startupRoute:
{
path: string ,
port: integer ,
}
,
scoringRoute:
{
path: string ,
port: integer ,
}
,
}
,
osType: enum ,
provisioningState: enum ,
stage: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
EnvironmentVersions_List (updated)
Description List versions.
Reference Link ¶

⚶ Changes

{
  "#id": "EnvironmentVersions_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "inferenceConfig": [
                  {
                    "@added_d423d4e732d245a4a8248e37313419cc": {
                      "#name": "startupRoute",
                      "Description": "The route to check the startup of the application in the container.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "path",
                          "Description": "[Required] The path for the route.",
                          "Required": true,
                          "Type": "string"
                        },
                        {
                          "#name": "port",
                          "Description": "[Required] The port for the route.",
                          "Format": "int32",
                          "Required": true,
                          "Type": "integer"
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
name: string ,
api-version: string ,
$orderBy: string ,
$top: integer ,
$skip: string ,
listViewType: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
properties:
{
autoRebuild: enum ,
build:
{
contextUri: string ,
dockerfilePath: string ,
}
,
condaFile: string ,
environmentType: enum ,
image: string ,
imageDetails:
{
exists: boolean ,
image:
{
digest: string ,
hostname: string ,
repository: string ,
tag: string ,
}
,
vulnerabilityFindings:
{
assetId: string ,
criticalFindingsCount: integer ,
data:
[
{
cve: string ,
cveUrl: string ,
dueDate: string ,
id: string ,
packageDetails:
[
{
installPath: string ,
installedVersion: string ,
name: string ,
patchedVersion: string ,
}
,
]
,
patchable: boolean ,
providerId: string ,
publishDate: string ,
risk: enum ,
solution: string ,
title: string ,
vendorId: string ,
vendorUrl: string ,
}
,
]
,
generatedTime: string ,
highFindingsCount: integer ,
lastScanDate: string ,
scanner: string ,
source: string ,
totalFindingsCount: integer ,
}
,
}
,
inferenceConfig:
{
livenessRoute:
{
path: string ,
port: integer ,
}
,
readinessRoute:
{
path: string ,
port: integer ,
}
,
startupRoute:
{
path: string ,
port: integer ,
}
,
scoringRoute:
{
path: string ,
port: integer ,
}
,
}
,
osType: enum ,
provisioningState: enum ,
stage: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
EnvironmentVersions_Get (updated)
Description Get version.
Reference Link ¶

⚶ Changes

{
  "#id": "EnvironmentVersions_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "inferenceConfig": [
              {
                "@added_81e29ae037b9403885e42ad80dcfaaa8": {
                  "#name": "startupRoute",
                  "Description": "The route to check the startup of the application in the container.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "path",
                      "Description": "[Required] The path for the route.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "port",
                      "Description": "[Required] The port for the route.",
                      "Format": "int32",
                      "Required": true,
                      "Type": "integer"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
name: string ,
version: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
autoRebuild: enum ,
build:
{
contextUri: string ,
dockerfilePath: string ,
}
,
condaFile: string ,
environmentType: enum ,
image: string ,
imageDetails:
{
exists: boolean ,
image:
{
digest: string ,
hostname: string ,
repository: string ,
tag: string ,
}
,
vulnerabilityFindings:
{
assetId: string ,
criticalFindingsCount: integer ,
data:
[
{
cve: string ,
cveUrl: string ,
dueDate: string ,
id: string ,
packageDetails:
[
{
installPath: string ,
installedVersion: string ,
name: string ,
patchedVersion: string ,
}
,
]
,
patchable: boolean ,
providerId: string ,
publishDate: string ,
risk: enum ,
solution: string ,
title: string ,
vendorId: string ,
vendorUrl: string ,
}
,
]
,
generatedTime: string ,
highFindingsCount: integer ,
lastScanDate: string ,
scanner: string ,
source: string ,
totalFindingsCount: integer ,
}
,
}
,
inferenceConfig:
{
livenessRoute:
{
path: string ,
port: integer ,
}
,
readinessRoute:
{
path: string ,
port: integer ,
}
,
startupRoute:
{
path: string ,
port: integer ,
}
,
scoringRoute:
{
path: string ,
port: integer ,
}
,
}
,
osType: enum ,
provisioningState: enum ,
stage: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
EnvironmentVersions_CreateOrUpdate (updated)
Description Creates or updates an EnvironmentVersion.
Reference Link ¶

⚶ Changes

{
  "#id": "EnvironmentVersions_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "inferenceConfig": [
              {
                "@added_00ccee0c5c2d4f219fb54201d743ae98": {
                  "#name": "startupRoute",
                  "Description": "The route to check the startup of the application in the container.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "path",
                      "Description": "[Required] The path for the route.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "port",
                      "Description": "[Required] The port for the route.",
                      "Format": "int32",
                      "Required": true,
                      "Type": "integer"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "inferenceConfig": [
              {
                "@added_12d264470a8a4ef19c4ed0017a8338aa": {
                  "#name": "startupRoute",
                  "Description": "The route to check the startup of the application in the container.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "path",
                      "Description": "[Required] The path for the route.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "port",
                      "Description": "[Required] The port for the route.",
                      "Format": "int32",
                      "Required": true,
                      "Type": "integer"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "inferenceConfig": [
              {
                "@added_cc6ff9d9c08f499984c34ced28111cfd": {
                  "#name": "startupRoute",
                  "Description": "The route to check the startup of the application in the container.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "path",
                      "Description": "[Required] The path for the route.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "port",
                      "Description": "[Required] The port for the route.",
                      "Format": "int32",
                      "Required": true,
                      "Type": "integer"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
name: string ,
version: string ,
api-version: string ,
body:
{
properties:
{
autoRebuild: enum ,
build:
{
contextUri: string ,
dockerfilePath: string ,
}
,
condaFile: string ,
environmentType: enum ,
image: string ,
imageDetails:
{
exists: boolean ,
image:
{
digest: string ,
hostname: string ,
repository: string ,
tag: string ,
}
,
vulnerabilityFindings:
{
assetId: string ,
criticalFindingsCount: integer ,
data:
[
{
cve: string ,
cveUrl: string ,
dueDate: string ,
id: string ,
packageDetails:
[
{
installPath: string ,
installedVersion: string ,
name: string ,
patchedVersion: string ,
}
,
]
,
patchable: boolean ,
providerId: string ,
publishDate: string ,
risk: enum ,
solution: string ,
title: string ,
vendorId: string ,
vendorUrl: string ,
}
,
]
,
generatedTime: string ,
highFindingsCount: integer ,
lastScanDate: string ,
scanner: string ,
source: string ,
totalFindingsCount: integer ,
}
,
}
,
inferenceConfig:
{
livenessRoute:
{
path: string ,
port: integer ,
}
,
readinessRoute:
{
path: string ,
port: integer ,
}
,
startupRoute:
{
path: string ,
port: integer ,
}
,
scoringRoute:
{
path: string ,
port: integer ,
}
,
}
,
osType: enum ,
provisioningState: enum ,
stage: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
autoRebuild: enum ,
build:
{
contextUri: string ,
dockerfilePath: string ,
}
,
condaFile: string ,
environmentType: enum ,
image: string ,
imageDetails:
{
exists: boolean ,
image:
{
digest: string ,
hostname: string ,
repository: string ,
tag: string ,
}
,
vulnerabilityFindings:
{
assetId: string ,
criticalFindingsCount: integer ,
data:
[
{
cve: string ,
cveUrl: string ,
dueDate: string ,
id: string ,
packageDetails:
[
{
installPath: string ,
installedVersion: string ,
name: string ,
patchedVersion: string ,
}
,
]
,
patchable: boolean ,
providerId: string ,
publishDate: string ,
risk: enum ,
solution: string ,
title: string ,
vendorId: string ,
vendorUrl: string ,
}
,
]
,
generatedTime: string ,
highFindingsCount: integer ,
lastScanDate: string ,
scanner: string ,
source: string ,
totalFindingsCount: integer ,
}
,
}
,
inferenceConfig:
{
livenessRoute:
{
path: string ,
port: integer ,
}
,
readinessRoute:
{
path: string ,
port: integer ,
}
,
startupRoute:
{
path: string ,
port: integer ,
}
,
scoringRoute:
{
path: string ,
port: integer ,
}
,
}
,
osType: enum ,
provisioningState: enum ,
stage: string ,
}
,
}

⚐ Response (201)

{
properties:
{
autoRebuild: enum ,
build:
{
contextUri: string ,
dockerfilePath: string ,
}
,
condaFile: string ,
environmentType: enum ,
image: string ,
imageDetails:
{
exists: boolean ,
image:
{
digest: string ,
hostname: string ,
repository: string ,
tag: string ,
}
,
vulnerabilityFindings:
{
assetId: string ,
criticalFindingsCount: integer ,
data:
[
{
cve: string ,
cveUrl: string ,
dueDate: string ,
id: string ,
packageDetails:
[
{
installPath: string ,
installedVersion: string ,
name: string ,
patchedVersion: string ,
}
,
]
,
patchable: boolean ,
providerId: string ,
publishDate: string ,
risk: enum ,
solution: string ,
title: string ,
vendorId: string ,
vendorUrl: string ,
}
,
]
,
generatedTime: string ,
highFindingsCount: integer ,
lastScanDate: string ,
scanner: string ,
source: string ,
totalFindingsCount: integer ,
}
,
}
,
inferenceConfig:
{
livenessRoute:
{
path: string ,
port: integer ,
}
,
readinessRoute:
{
path: string ,
port: integer ,
}
,
startupRoute:
{
path: string ,
port: integer ,
}
,
scoringRoute:
{
path: string ,
port: integer ,
}
,
}
,
osType: enum ,
provisioningState: enum ,
stage: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
OnlineDeployments_List (updated)
Description List Inference Endpoint Deployments.
Reference Link ¶

⚶ Changes

{
  "#id": "OnlineDeployments_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "@added_7fa86672cae945d49436263f1d9408f3": {
                  "#name": "startupProbe",
                  "Description": "Startup probe verify whether an application within a container has started successfully.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "failureThreshold",
                      "Description": "The number of failures to allow before returning an unhealthy status.",
                      "Format": "int32",
                      "Required": false,
                      "Type": "integer"
                    },
                    {
                      "#name": "initialDelay",
                      "Description": "The delay before the first probe in ISO 8601 format.",
                      "Format": "duration",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "period",
                      "Description": "The length of time between probes in ISO 8601 format.",
                      "Format": "duration",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "successThreshold",
                      "Description": "The number of successful probes before returning a healthy status.",
                      "Format": "int32",
                      "Required": false,
                      "Type": "integer"
                    },
                    {
                      "#name": "timeout",
                      "Description": "The probe timeout in ISO 8601 format.",
                      "Format": "duration",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
endpointName: string ,
api-version: string ,
$orderBy: string ,
$top: integer ,
$skip: string ,
}

⚐ Response (200)

{
nextLink: string ,
value:
[
{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
kind: string ,
properties:
{
appInsightsEnabled: boolean ,
dataCollector:
{
collections: object ,
requestLogging:
{
captureHeaders:
[
string ,
]
,
}
,
rollingRate: enum ,
}
,
egressPublicNetworkAccess: enum ,
endpointComputeType: enum ,
instanceType: string ,
livenessProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
model: string ,
modelMountPath: string ,
provisioningState: enum ,
readinessProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
startupProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
requestSettings:
{
maxConcurrentRequestsPerInstance: integer ,
maxQueueWait: string ,
requestTimeout: string ,
}
,
scaleSettings:
{
scaleType: enum ,
}
,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
OnlineDeployments_Get (updated)
Description Get Inference Deployment Deployment.
Reference Link ¶

⚶ Changes

{
  "#id": "OnlineDeployments_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_31a5f951619c4236a0e9c7ca3bd5a858": {
              "#name": "startupProbe",
              "Description": "Startup probe verify whether an application within a container has started successfully.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "failureThreshold",
                  "Description": "The number of failures to allow before returning an unhealthy status.",
                  "Format": "int32",
                  "Required": false,
                  "Type": "integer"
                },
                {
                  "#name": "initialDelay",
                  "Description": "The delay before the first probe in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "period",
                  "Description": "The length of time between probes in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "successThreshold",
                  "Description": "The number of successful probes before returning a healthy status.",
                  "Format": "int32",
                  "Required": false,
                  "Type": "integer"
                },
                {
                  "#name": "timeout",
                  "Description": "The probe timeout in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
endpointName: string ,
deploymentName: string ,
api-version: string ,
}

⚐ Response (200)

{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
kind: string ,
properties:
{
appInsightsEnabled: boolean ,
dataCollector:
{
collections: object ,
requestLogging:
{
captureHeaders:
[
string ,
]
,
}
,
rollingRate: enum ,
}
,
egressPublicNetworkAccess: enum ,
endpointComputeType: enum ,
instanceType: string ,
livenessProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
model: string ,
modelMountPath: string ,
provisioningState: enum ,
readinessProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
startupProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
requestSettings:
{
maxConcurrentRequestsPerInstance: integer ,
maxQueueWait: string ,
requestTimeout: string ,
}
,
scaleSettings:
{
scaleType: enum ,
}
,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
OnlineDeployments_Update (updated)
Description Update Online Deployment (asynchronous).
Reference Link ¶

⚶ Changes

{
  "#id": "OnlineDeployments_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_a49c0c9db2f44e34a1ae46bcce65f0fb": {
              "#name": "startupProbe",
              "Description": "Startup probe verify whether an application within a container has started successfully.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "failureThreshold",
                  "Description": "The number of failures to allow before returning an unhealthy status.",
                  "Format": "int32",
                  "Required": false,
                  "Type": "integer"
                },
                {
                  "#name": "initialDelay",
                  "Description": "The delay before the first probe in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "period",
                  "Description": "The length of time between probes in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "successThreshold",
                  "Description": "The number of successful probes before returning a healthy status.",
                  "Format": "int32",
                  "Required": false,
                  "Type": "integer"
                },
                {
                  "#name": "timeout",
                  "Description": "The probe timeout in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
endpointName: string ,
deploymentName: string ,
api-version: string ,
body:
{
sku:
{
capacity: integer ,
family: string ,
name: string ,
size: string ,
tier: enum ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
kind: string ,
properties:
{
appInsightsEnabled: boolean ,
dataCollector:
{
collections: object ,
requestLogging:
{
captureHeaders:
[
string ,
]
,
}
,
rollingRate: enum ,
}
,
egressPublicNetworkAccess: enum ,
endpointComputeType: enum ,
instanceType: string ,
livenessProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
model: string ,
modelMountPath: string ,
provisioningState: enum ,
readinessProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
startupProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
requestSettings:
{
maxConcurrentRequestsPerInstance: integer ,
maxQueueWait: string ,
requestTimeout: string ,
}
,
scaleSettings:
{
scaleType: enum ,
}
,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (202)

{
x-ms-async-operation-timeout: string ,
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
OnlineDeployments_CreateOrUpdate (updated)
Description Create or update Inference Endpoint Deployment (asynchronous).
Reference Link ¶

⚶ Changes

{
  "#id": "OnlineDeployments_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "@added_0f12f7d907f4405e88d69ac497dc7076": {
              "#name": "startupProbe",
              "Description": "Startup probe verify whether an application within a container has started successfully.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "failureThreshold",
                  "Description": "The number of failures to allow before returning an unhealthy status.",
                  "Format": "int32",
                  "Required": false,
                  "Type": "integer"
                },
                {
                  "#name": "initialDelay",
                  "Description": "The delay before the first probe in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "period",
                  "Description": "The length of time between probes in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "successThreshold",
                  "Description": "The number of successful probes before returning a healthy status.",
                  "Format": "int32",
                  "Required": false,
                  "Type": "integer"
                },
                {
                  "#name": "timeout",
                  "Description": "The probe timeout in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_225f7e9561d149618b458a50594ad943": {
              "#name": "startupProbe",
              "Description": "Startup probe verify whether an application within a container has started successfully.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "failureThreshold",
                  "Description": "The number of failures to allow before returning an unhealthy status.",
                  "Format": "int32",
                  "Required": false,
                  "Type": "integer"
                },
                {
                  "#name": "initialDelay",
                  "Description": "The delay before the first probe in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "period",
                  "Description": "The length of time between probes in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "successThreshold",
                  "Description": "The number of successful probes before returning a healthy status.",
                  "Format": "int32",
                  "Required": false,
                  "Type": "integer"
                },
                {
                  "#name": "timeout",
                  "Description": "The probe timeout in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "@added_2c229860723c4b2e8513f70df90ad17b": {
              "#name": "startupProbe",
              "Description": "Startup probe verify whether an application within a container has started successfully.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "failureThreshold",
                  "Description": "The number of failures to allow before returning an unhealthy status.",
                  "Format": "int32",
                  "Required": false,
                  "Type": "integer"
                },
                {
                  "#name": "initialDelay",
                  "Description": "The delay before the first probe in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "period",
                  "Description": "The length of time between probes in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "successThreshold",
                  "Description": "The number of successful probes before returning a healthy status.",
                  "Format": "int32",
                  "Required": false,
                  "Type": "integer"
                },
                {
                  "#name": "timeout",
                  "Description": "The probe timeout in ISO 8601 format.",
                  "Format": "duration",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}
{
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
endpointName: string ,
deploymentName: string ,
api-version: string ,
body:
{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
kind: string ,
properties:
{
appInsightsEnabled: boolean ,
dataCollector:
{
collections: object ,
requestLogging:
{
captureHeaders:
[
string ,
]
,
}
,
rollingRate: enum ,
}
,
egressPublicNetworkAccess: enum ,
endpointComputeType: enum ,
instanceType: string ,
livenessProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
model: string ,
modelMountPath: string ,
provisioningState: enum ,
readinessProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
startupProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
requestSettings:
{
maxConcurrentRequestsPerInstance: integer ,
maxQueueWait: string ,
requestTimeout: string ,
}
,
scaleSettings:
{
scaleType: enum ,
}
,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
kind: string ,
properties:
{
appInsightsEnabled: boolean ,
dataCollector:
{
collections: object ,
requestLogging:
{
captureHeaders:
[
string ,
]
,
}
,
rollingRate: enum ,
}
,
egressPublicNetworkAccess: enum ,
endpointComputeType: enum ,
instanceType: string ,
livenessProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
model: string ,
modelMountPath: string ,
provisioningState: enum ,
readinessProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
startupProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
requestSettings:
{
maxConcurrentRequestsPerInstance: integer ,
maxQueueWait: string ,
requestTimeout: string ,
}
,
scaleSettings:
{
scaleType: enum ,
}
,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-async-operation-timeout: string ,
azure-asyncoperation: string ,
}
,
$schema:
{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
kind: string ,
properties:
{
appInsightsEnabled: boolean ,
dataCollector:
{
collections: object ,
requestLogging:
{
captureHeaders:
[
string ,
]
,
}
,
rollingRate: enum ,
}
,
egressPublicNetworkAccess: enum ,
endpointComputeType: enum ,
instanceType: string ,
livenessProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
model: string ,
modelMountPath: string ,
provisioningState: enum ,
readinessProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
startupProbe:
{
failureThreshold: integer ,
initialDelay: string ,
period: string ,
successThreshold: integer ,
timeout: string ,
}
,
requestSettings:
{
maxConcurrentRequestsPerInstance: integer ,
maxQueueWait: string ,
requestTimeout: string ,
}
,
scaleSettings:
{
scaleType: enum ,
}
,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}