Microsoft.MachineLearningServices (stable:2024-10-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_a7bcc1b1bc244e15998ebb65085520a2": {
                      "#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:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
registryName:
{
Description: Name of Azure Machine Learning registry. This is case-insensitive ,
Required: True ,
}
string ,
environmentName:
{
Description: Container name. This is case-sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$orderBy:
{
Description: Ordering of list. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
listViewType:
{
Description: View type for including/excluding (for example) archived entities. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of EnvironmentVersion objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type EnvironmentVersion. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
autoRebuild:
{
Description: Defines if image needs to be rebuilt based on base image changes. ,
Enum:
{
Disabled: No description available. ,
OnBaseImageUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
build:
{
Description: Configuration settings for Docker build context. ,
Required: False ,
}
{
contextUri:
{
Description: [Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs. ,
Required: True ,
}
string ,
dockerfilePath:
{
Description: Path to the Dockerfile in the build context. ,
Required: False ,
}
string ,
}
,
condaFile:
{
Description: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. ,
Required: False ,
}
string ,
environmentType:
{
Description: Environment type is either user managed or curated by the Azure ML service ,
Enum:
{
Curated: No description available. ,
UserCreated: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Name of the image that will be used for the environment. ,
Required: False ,
}
string ,
inferenceConfig:
{
Description: Defines configuration specific to inference. ,
Required: False ,
}
{
livenessRoute:
{
Description: The route to check the liveness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
readinessRoute:
{
Description: The route to check the readiness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
startupRoute:
{
Description: The route to check the startup of the application in the container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
scoringRoute:
{
Description: The port to send the scoring requests to, within the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
osType:
{
Description: The OS type of the environment. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state for the environment version. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
stage:
{
Description: Stage in the environment lifecycle assigned to this environment ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "RegistryEnvironmentVersions_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "inferenceConfig": [
              {
                "@added_546e5bcec0cf4f48a104fc6708bd49f8": {
                  "#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:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
registryName:
{
Description: Name of Azure Machine Learning registry. This is case-insensitive ,
Required: True ,
}
string ,
environmentName:
{
Description: Container name. This is case-sensitive. ,
Required: True ,
}
string ,
version:
{
Description: Version identifier. This is case-sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
autoRebuild:
{
Description: Defines if image needs to be rebuilt based on base image changes. ,
Enum:
{
Disabled: No description available. ,
OnBaseImageUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
build:
{
Description: Configuration settings for Docker build context. ,
Required: False ,
}
{
contextUri:
{
Description: [Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs. ,
Required: True ,
}
string ,
dockerfilePath:
{
Description: Path to the Dockerfile in the build context. ,
Required: False ,
}
string ,
}
,
condaFile:
{
Description: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. ,
Required: False ,
}
string ,
environmentType:
{
Description: Environment type is either user managed or curated by the Azure ML service ,
Enum:
{
Curated: No description available. ,
UserCreated: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Name of the image that will be used for the environment. ,
Required: False ,
}
string ,
inferenceConfig:
{
Description: Defines configuration specific to inference. ,
Required: False ,
}
{
livenessRoute:
{
Description: The route to check the liveness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
readinessRoute:
{
Description: The route to check the readiness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
startupRoute:
{
Description: The route to check the startup of the application in the container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
scoringRoute:
{
Description: The port to send the scoring requests to, within the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
osType:
{
Description: The OS type of the environment. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state for the environment version. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
stage:
{
Description: Stage in the environment lifecycle assigned to this environment ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "RegistryEnvironmentVersions_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "inferenceConfig": [
              {
                "@added_e96319fdbd614f41bce71a4cecd7916d": {
                  "#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_99f5a4c4f4c64363aca44e031f683c1e": {
                  "#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_bd39df5d7690435698af8eedc8942423": {
                  "#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:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
registryName:
{
Description: Name of Azure Machine Learning registry. This is case-insensitive ,
Required: True ,
}
string ,
environmentName:
{
Description: Container name. ,
Required: True ,
}
string ,
version:
{
Description: Version identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Version entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
autoRebuild:
{
Description: Defines if image needs to be rebuilt based on base image changes. ,
Enum:
{
Disabled: No description available. ,
OnBaseImageUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
build:
{
Description: Configuration settings for Docker build context. ,
Required: False ,
}
{
contextUri:
{
Description: [Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs. ,
Required: True ,
}
string ,
dockerfilePath:
{
Description: Path to the Dockerfile in the build context. ,
Required: False ,
}
string ,
}
,
condaFile:
{
Description: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. ,
Required: False ,
}
string ,
environmentType:
{
Description: Environment type is either user managed or curated by the Azure ML service ,
Enum:
{
Curated: No description available. ,
UserCreated: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Name of the image that will be used for the environment. ,
Required: False ,
}
string ,
inferenceConfig:
{
Description: Defines configuration specific to inference. ,
Required: False ,
}
{
livenessRoute:
{
Description: The route to check the liveness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
readinessRoute:
{
Description: The route to check the readiness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
startupRoute:
{
Description: The route to check the startup of the application in the container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
scoringRoute:
{
Description: The port to send the scoring requests to, within the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
osType:
{
Description: The OS type of the environment. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state for the environment version. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
stage:
{
Description: Stage in the environment lifecycle assigned to this environment ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
autoRebuild:
{
Description: Defines if image needs to be rebuilt based on base image changes. ,
Enum:
{
Disabled: No description available. ,
OnBaseImageUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
build:
{
Description: Configuration settings for Docker build context. ,
Required: False ,
}
{
contextUri:
{
Description: [Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs. ,
Required: True ,
}
string ,
dockerfilePath:
{
Description: Path to the Dockerfile in the build context. ,
Required: False ,
}
string ,
}
,
condaFile:
{
Description: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. ,
Required: False ,
}
string ,
environmentType:
{
Description: Environment type is either user managed or curated by the Azure ML service ,
Enum:
{
Curated: No description available. ,
UserCreated: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Name of the image that will be used for the environment. ,
Required: False ,
}
string ,
inferenceConfig:
{
Description: Defines configuration specific to inference. ,
Required: False ,
}
{
livenessRoute:
{
Description: The route to check the liveness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
readinessRoute:
{
Description: The route to check the readiness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
startupRoute:
{
Description: The route to check the startup of the application in the container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
scoringRoute:
{
Description: The port to send the scoring requests to, within the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
osType:
{
Description: The OS type of the environment. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state for the environment version. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
stage:
{
Description: Stage in the environment lifecycle assigned to this environment ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-async-operation-timeout:
{
Description: Timeout for the client to use when polling the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for asynchronous operation status. ,
}
string ,
}
,
$schema:
{
Description: Azure Resource Manager resource envelope. ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
autoRebuild:
{
Description: Defines if image needs to be rebuilt based on base image changes. ,
Enum:
{
Disabled: No description available. ,
OnBaseImageUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
build:
{
Description: Configuration settings for Docker build context. ,
Required: False ,
}
{
contextUri:
{
Description: [Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs. ,
Required: True ,
}
string ,
dockerfilePath:
{
Description: Path to the Dockerfile in the build context. ,
Required: False ,
}
string ,
}
,
condaFile:
{
Description: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. ,
Required: False ,
}
string ,
environmentType:
{
Description: Environment type is either user managed or curated by the Azure ML service ,
Enum:
{
Curated: No description available. ,
UserCreated: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Name of the image that will be used for the environment. ,
Required: False ,
}
string ,
inferenceConfig:
{
Description: Defines configuration specific to inference. ,
Required: False ,
}
{
livenessRoute:
{
Description: The route to check the liveness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
readinessRoute:
{
Description: The route to check the readiness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
startupRoute:
{
Description: The route to check the startup of the application in the container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
scoringRoute:
{
Description: The port to send the scoring requests to, within the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
osType:
{
Description: The OS type of the environment. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state for the environment version. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
stage:
{
Description: Stage in the environment lifecycle assigned to this environment ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "EnvironmentVersions_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "inferenceConfig": [
                  {
                    "@added_afec768dfb284d1c8a2e9032b3773352": {
                      "#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:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
name:
{
Description: Container name. This is case-sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$orderBy:
{
Description: Ordering of list. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
listViewType:
{
Description: View type for including/excluding (for example) archived entities. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of EnvironmentVersion objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type EnvironmentVersion. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
autoRebuild:
{
Description: Defines if image needs to be rebuilt based on base image changes. ,
Enum:
{
Disabled: No description available. ,
OnBaseImageUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
build:
{
Description: Configuration settings for Docker build context. ,
Required: False ,
}
{
contextUri:
{
Description: [Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs. ,
Required: True ,
}
string ,
dockerfilePath:
{
Description: Path to the Dockerfile in the build context. ,
Required: False ,
}
string ,
}
,
condaFile:
{
Description: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. ,
Required: False ,
}
string ,
environmentType:
{
Description: Environment type is either user managed or curated by the Azure ML service ,
Enum:
{
Curated: No description available. ,
UserCreated: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Name of the image that will be used for the environment. ,
Required: False ,
}
string ,
inferenceConfig:
{
Description: Defines configuration specific to inference. ,
Required: False ,
}
{
livenessRoute:
{
Description: The route to check the liveness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
readinessRoute:
{
Description: The route to check the readiness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
startupRoute:
{
Description: The route to check the startup of the application in the container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
scoringRoute:
{
Description: The port to send the scoring requests to, within the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
osType:
{
Description: The OS type of the environment. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state for the environment version. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
stage:
{
Description: Stage in the environment lifecycle assigned to this environment ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "EnvironmentVersions_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "inferenceConfig": [
              {
                "@added_a65ead2f0ef34ac89da590d66e8404cc": {
                  "#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:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
name:
{
Description: Container name. This is case-sensitive. ,
Required: True ,
}
string ,
version:
{
Description: Version identifier. This is case-sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
autoRebuild:
{
Description: Defines if image needs to be rebuilt based on base image changes. ,
Enum:
{
Disabled: No description available. ,
OnBaseImageUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
build:
{
Description: Configuration settings for Docker build context. ,
Required: False ,
}
{
contextUri:
{
Description: [Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs. ,
Required: True ,
}
string ,
dockerfilePath:
{
Description: Path to the Dockerfile in the build context. ,
Required: False ,
}
string ,
}
,
condaFile:
{
Description: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. ,
Required: False ,
}
string ,
environmentType:
{
Description: Environment type is either user managed or curated by the Azure ML service ,
Enum:
{
Curated: No description available. ,
UserCreated: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Name of the image that will be used for the environment. ,
Required: False ,
}
string ,
inferenceConfig:
{
Description: Defines configuration specific to inference. ,
Required: False ,
}
{
livenessRoute:
{
Description: The route to check the liveness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
readinessRoute:
{
Description: The route to check the readiness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
startupRoute:
{
Description: The route to check the startup of the application in the container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
scoringRoute:
{
Description: The port to send the scoring requests to, within the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
osType:
{
Description: The OS type of the environment. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state for the environment version. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
stage:
{
Description: Stage in the environment lifecycle assigned to this environment ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "EnvironmentVersions_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "inferenceConfig": [
              {
                "@added_9057966760ce44e198c34ad47af726c5": {
                  "#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_57d6280620f2443d8313deeaf9fa2059": {
                  "#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_e4a3e951d5de4f7990caff52e5f9a153": {
                  "#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:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
name:
{
Description: Name of EnvironmentVersion. This is case-sensitive. ,
Required: True ,
}
string ,
version:
{
Description: Version of EnvironmentVersion. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Definition of EnvironmentVersion. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
autoRebuild:
{
Description: Defines if image needs to be rebuilt based on base image changes. ,
Enum:
{
Disabled: No description available. ,
OnBaseImageUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
build:
{
Description: Configuration settings for Docker build context. ,
Required: False ,
}
{
contextUri:
{
Description: [Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs. ,
Required: True ,
}
string ,
dockerfilePath:
{
Description: Path to the Dockerfile in the build context. ,
Required: False ,
}
string ,
}
,
condaFile:
{
Description: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. ,
Required: False ,
}
string ,
environmentType:
{
Description: Environment type is either user managed or curated by the Azure ML service ,
Enum:
{
Curated: No description available. ,
UserCreated: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Name of the image that will be used for the environment. ,
Required: False ,
}
string ,
inferenceConfig:
{
Description: Defines configuration specific to inference. ,
Required: False ,
}
{
livenessRoute:
{
Description: The route to check the liveness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
readinessRoute:
{
Description: The route to check the readiness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
startupRoute:
{
Description: The route to check the startup of the application in the container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
scoringRoute:
{
Description: The port to send the scoring requests to, within the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
osType:
{
Description: The OS type of the environment. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state for the environment version. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
stage:
{
Description: Stage in the environment lifecycle assigned to this environment ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
autoRebuild:
{
Description: Defines if image needs to be rebuilt based on base image changes. ,
Enum:
{
Disabled: No description available. ,
OnBaseImageUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
build:
{
Description: Configuration settings for Docker build context. ,
Required: False ,
}
{
contextUri:
{
Description: [Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs. ,
Required: True ,
}
string ,
dockerfilePath:
{
Description: Path to the Dockerfile in the build context. ,
Required: False ,
}
string ,
}
,
condaFile:
{
Description: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. ,
Required: False ,
}
string ,
environmentType:
{
Description: Environment type is either user managed or curated by the Azure ML service ,
Enum:
{
Curated: No description available. ,
UserCreated: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Name of the image that will be used for the environment. ,
Required: False ,
}
string ,
inferenceConfig:
{
Description: Defines configuration specific to inference. ,
Required: False ,
}
{
livenessRoute:
{
Description: The route to check the liveness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
readinessRoute:
{
Description: The route to check the readiness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
startupRoute:
{
Description: The route to check the startup of the application in the container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
scoringRoute:
{
Description: The port to send the scoring requests to, within the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
osType:
{
Description: The OS type of the environment. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state for the environment version. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
stage:
{
Description: Stage in the environment lifecycle assigned to this environment ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
autoRebuild:
{
Description: Defines if image needs to be rebuilt based on base image changes. ,
Enum:
{
Disabled: No description available. ,
OnBaseImageUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
build:
{
Description: Configuration settings for Docker build context. ,
Required: False ,
}
{
contextUri:
{
Description: [Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs. ,
Required: True ,
}
string ,
dockerfilePath:
{
Description: Path to the Dockerfile in the build context. ,
Required: False ,
}
string ,
}
,
condaFile:
{
Description: Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. ,
Required: False ,
}
string ,
environmentType:
{
Description: Environment type is either user managed or curated by the Azure ML service ,
Enum:
{
Curated: No description available. ,
UserCreated: No description available. ,
}
,
Required: False ,
}
enum ,
image:
{
Description: Name of the image that will be used for the environment. ,
Required: False ,
}
string ,
inferenceConfig:
{
Description: Defines configuration specific to inference. ,
Required: False ,
}
{
livenessRoute:
{
Description: The route to check the liveness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
readinessRoute:
{
Description: The route to check the readiness of the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
startupRoute:
{
Description: The route to check the startup of the application in the container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
scoringRoute:
{
Description: The port to send the scoring requests to, within the inference server container. ,
Required: False ,
}
{
path:
{
Description: [Required] The path for the route. ,
Required: True ,
}
string ,
port:
{
Description: [Required] The port for the route. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
osType:
{
Description: The OS type of the environment. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state for the environment version. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
stage:
{
Description: Stage in the environment lifecycle assigned to this environment ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "OnlineDeployments_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "startupProbe",
                "Description": {
                  "new": "Startup probe verify whether an application within a container has started successfully.",
                  "old": "This verifies whether the application within a container is started. Startup probes run before any other probe, and, unless it finishes successfully, disables other probes."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
endpointName:
{
Description: Inference endpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$orderBy:
{
Description: Ordering of list. ,
Required: False ,
}
string ,
$top:
{
Description: Top of list. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of OnlineDeployment objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type OnlineDeployment. ,
Required: False ,
}
[
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
appInsightsEnabled:
{
Description: If true, enables Application Insights logging. ,
Required: False ,
}
boolean ,
dataCollector:
{
Description: The mdc configuration, we disable mdc when it's null. ,
Required: False ,
}
{
collections:
{
Description: [Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string. Model data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging. ,
Required: True ,
}
object ,
requestLogging:
{
Description: The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional. ,
Required: False ,
}
{
captureHeaders:
{
Description: For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload. ,
Required: False ,
}
[
string ,
]
,
}
,
rollingRate:
{
Description: When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file. If the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/. If it's day, all data will be collected in blob path /yyyy/MM/dd/. The other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly. ,
Enum:
{
Year: No description available. ,
Month: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Minute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
egressPublicNetworkAccess:
{
Description: If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
endpointComputeType:
{
Description: [Required] The compute type of the endpoint. ,
Enum:
{
Managed: No description available. ,
Kubernetes: No description available. ,
AzureMLCompute: No description available. ,
}
,
Required: True ,
}
enum ,
instanceType:
{
Description: Compute instance type. Default: Standard_F4s_v2. ,
Required: False ,
}
string ,
livenessProbe:
{
Description: Liveness probe monitors the health of the container regularly. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
model:
{
Description: The URI path to the model. ,
Required: False ,
}
string ,
modelMountPath:
{
Description: The path to mount the model in custom container. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the endpoint deployment. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
readinessProbe:
{
Description: Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
startupProbe:
{
Description: Startup probe verify whether an application within a container has started successfully. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
requestSettings:
{
Description: Request settings for the deployment. ,
Required: False ,
}
{
maxConcurrentRequestsPerInstance:
{
Description: The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. ,
Format: int32 ,
Required: False ,
}
integer ,
maxQueueWait:
{
Description: (Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format. Defaults to 500ms. (Now increase `request_timeout_ms` to account for any networking/queue delays) ,
Format: duration ,
Required: False ,
}
string ,
requestTimeout:
{
Description: The scoring timeout in ISO 8601 format. Defaults to 5000ms. ,
Format: duration ,
Required: False ,
}
string ,
}
,
scaleSettings:
{
Description: Scale settings for the deployment. If it is null or not provided, it defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment and to DefaultScaleSettings for ManagedOnlineDeployment. ,
Required: False ,
}
{
scaleType:
{
Description: [Required] Type of deployment scaling algorithm ,
Enum:
{
Default: No description available. ,
TargetUtilization: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "OnlineDeployments_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "startupProbe",
            "Description": {
              "new": "Startup probe verify whether an application within a container has started successfully.",
              "old": "This verifies whether the application within a container is started. Startup probes run before any other probe, and, unless it finishes successfully, disables other probes."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
endpointName:
{
Description: Inference endpoint name. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Inference Endpoint Deployment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
appInsightsEnabled:
{
Description: If true, enables Application Insights logging. ,
Required: False ,
}
boolean ,
dataCollector:
{
Description: The mdc configuration, we disable mdc when it's null. ,
Required: False ,
}
{
collections:
{
Description: [Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string. Model data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging. ,
Required: True ,
}
object ,
requestLogging:
{
Description: The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional. ,
Required: False ,
}
{
captureHeaders:
{
Description: For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload. ,
Required: False ,
}
[
string ,
]
,
}
,
rollingRate:
{
Description: When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file. If the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/. If it's day, all data will be collected in blob path /yyyy/MM/dd/. The other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly. ,
Enum:
{
Year: No description available. ,
Month: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Minute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
egressPublicNetworkAccess:
{
Description: If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
endpointComputeType:
{
Description: [Required] The compute type of the endpoint. ,
Enum:
{
Managed: No description available. ,
Kubernetes: No description available. ,
AzureMLCompute: No description available. ,
}
,
Required: True ,
}
enum ,
instanceType:
{
Description: Compute instance type. Default: Standard_F4s_v2. ,
Required: False ,
}
string ,
livenessProbe:
{
Description: Liveness probe monitors the health of the container regularly. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
model:
{
Description: The URI path to the model. ,
Required: False ,
}
string ,
modelMountPath:
{
Description: The path to mount the model in custom container. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the endpoint deployment. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
readinessProbe:
{
Description: Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
startupProbe:
{
Description: Startup probe verify whether an application within a container has started successfully. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
requestSettings:
{
Description: Request settings for the deployment. ,
Required: False ,
}
{
maxConcurrentRequestsPerInstance:
{
Description: The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. ,
Format: int32 ,
Required: False ,
}
integer ,
maxQueueWait:
{
Description: (Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format. Defaults to 500ms. (Now increase `request_timeout_ms` to account for any networking/queue delays) ,
Format: duration ,
Required: False ,
}
string ,
requestTimeout:
{
Description: The scoring timeout in ISO 8601 format. Defaults to 5000ms. ,
Format: duration ,
Required: False ,
}
string ,
}
,
scaleSettings:
{
Description: Scale settings for the deployment. If it is null or not provided, it defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment and to DefaultScaleSettings for ManagedOnlineDeployment. ,
Required: False ,
}
{
scaleType:
{
Description: [Required] Type of deployment scaling algorithm ,
Enum:
{
Default: No description available. ,
TargetUtilization: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "OnlineDeployments_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "startupProbe",
            "Description": {
              "new": "Startup probe verify whether an application within a container has started successfully.",
              "old": "This verifies whether the application within a container is started. Startup probes run before any other probe, and, unless it finishes successfully, disables other probes."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
endpointName:
{
Description: Online Endpoint name. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Inference Endpoint Deployment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Online Endpoint entity to apply during operation. ,
Required: True ,
}
{
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
appInsightsEnabled:
{
Description: If true, enables Application Insights logging. ,
Required: False ,
}
boolean ,
dataCollector:
{
Description: The mdc configuration, we disable mdc when it's null. ,
Required: False ,
}
{
collections:
{
Description: [Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string. Model data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging. ,
Required: True ,
}
object ,
requestLogging:
{
Description: The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional. ,
Required: False ,
}
{
captureHeaders:
{
Description: For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload. ,
Required: False ,
}
[
string ,
]
,
}
,
rollingRate:
{
Description: When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file. If the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/. If it's day, all data will be collected in blob path /yyyy/MM/dd/. The other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly. ,
Enum:
{
Year: No description available. ,
Month: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Minute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
egressPublicNetworkAccess:
{
Description: If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
endpointComputeType:
{
Description: [Required] The compute type of the endpoint. ,
Enum:
{
Managed: No description available. ,
Kubernetes: No description available. ,
AzureMLCompute: No description available. ,
}
,
Required: True ,
}
enum ,
instanceType:
{
Description: Compute instance type. Default: Standard_F4s_v2. ,
Required: False ,
}
string ,
livenessProbe:
{
Description: Liveness probe monitors the health of the container regularly. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
model:
{
Description: The URI path to the model. ,
Required: False ,
}
string ,
modelMountPath:
{
Description: The path to mount the model in custom container. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the endpoint deployment. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
readinessProbe:
{
Description: Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
startupProbe:
{
Description: Startup probe verify whether an application within a container has started successfully. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
requestSettings:
{
Description: Request settings for the deployment. ,
Required: False ,
}
{
maxConcurrentRequestsPerInstance:
{
Description: The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. ,
Format: int32 ,
Required: False ,
}
integer ,
maxQueueWait:
{
Description: (Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format. Defaults to 500ms. (Now increase `request_timeout_ms` to account for any networking/queue delays) ,
Format: duration ,
Required: False ,
}
string ,
requestTimeout:
{
Description: The scoring timeout in ISO 8601 format. Defaults to 5000ms. ,
Format: duration ,
Required: False ,
}
string ,
}
,
scaleSettings:
{
Description: Scale settings for the deployment. If it is null or not provided, it defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment and to DefaultScaleSettings for ManagedOnlineDeployment. ,
Required: False ,
}
{
scaleType:
{
Description: [Required] Type of deployment scaling algorithm ,
Enum:
{
Default: No description available. ,
TargetUtilization: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
x-ms-async-operation-timeout:
{
Description: Timeout for the client to use when polling the asynchronous operation. ,
}
string ,
location:
{
Description: URI to poll for asynchronous operation result. ,
}
string ,
retry-after:
{
Description: Duration the client should wait between requests, in seconds. ,
}
integer ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "OnlineDeployments_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "#name": "startupProbe",
            "Description": {
              "new": "Startup probe verify whether an application within a container has started successfully.",
              "old": "This verifies whether the application within a container is started. Startup probes run before any other probe, and, unless it finishes successfully, disables other probes."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "startupProbe",
            "Description": {
              "new": "Startup probe verify whether an application within a container has started successfully.",
              "old": "This verifies whether the application within a container is started. Startup probes run before any other probe, and, unless it finishes successfully, disables other probes."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "startupProbe",
            "Description": {
              "new": "Startup probe verify whether an application within a container has started successfully.",
              "old": "This verifies whether the application within a container is started. Startup probes run before any other probe, and, unless it finishes successfully, disables other probes."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
endpointName:
{
Description: Inference endpoint name. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Inference Endpoint Deployment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Inference Endpoint entity to apply during operation. ,
Required: True ,
}
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
appInsightsEnabled:
{
Description: If true, enables Application Insights logging. ,
Required: False ,
}
boolean ,
dataCollector:
{
Description: The mdc configuration, we disable mdc when it's null. ,
Required: False ,
}
{
collections:
{
Description: [Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string. Model data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging. ,
Required: True ,
}
object ,
requestLogging:
{
Description: The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional. ,
Required: False ,
}
{
captureHeaders:
{
Description: For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload. ,
Required: False ,
}
[
string ,
]
,
}
,
rollingRate:
{
Description: When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file. If the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/. If it's day, all data will be collected in blob path /yyyy/MM/dd/. The other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly. ,
Enum:
{
Year: No description available. ,
Month: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Minute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
egressPublicNetworkAccess:
{
Description: If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
endpointComputeType:
{
Description: [Required] The compute type of the endpoint. ,
Enum:
{
Managed: No description available. ,
Kubernetes: No description available. ,
AzureMLCompute: No description available. ,
}
,
Required: True ,
}
enum ,
instanceType:
{
Description: Compute instance type. Default: Standard_F4s_v2. ,
Required: False ,
}
string ,
livenessProbe:
{
Description: Liveness probe monitors the health of the container regularly. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
model:
{
Description: The URI path to the model. ,
Required: False ,
}
string ,
modelMountPath:
{
Description: The path to mount the model in custom container. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the endpoint deployment. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
readinessProbe:
{
Description: Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
startupProbe:
{
Description: Startup probe verify whether an application within a container has started successfully. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
requestSettings:
{
Description: Request settings for the deployment. ,
Required: False ,
}
{
maxConcurrentRequestsPerInstance:
{
Description: The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. ,
Format: int32 ,
Required: False ,
}
integer ,
maxQueueWait:
{
Description: (Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format. Defaults to 500ms. (Now increase `request_timeout_ms` to account for any networking/queue delays) ,
Format: duration ,
Required: False ,
}
string ,
requestTimeout:
{
Description: The scoring timeout in ISO 8601 format. Defaults to 5000ms. ,
Format: duration ,
Required: False ,
}
string ,
}
,
scaleSettings:
{
Description: Scale settings for the deployment. If it is null or not provided, it defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment and to DefaultScaleSettings for ManagedOnlineDeployment. ,
Required: False ,
}
{
scaleType:
{
Description: [Required] Type of deployment scaling algorithm ,
Enum:
{
Default: No description available. ,
TargetUtilization: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
appInsightsEnabled:
{
Description: If true, enables Application Insights logging. ,
Required: False ,
}
boolean ,
dataCollector:
{
Description: The mdc configuration, we disable mdc when it's null. ,
Required: False ,
}
{
collections:
{
Description: [Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string. Model data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging. ,
Required: True ,
}
object ,
requestLogging:
{
Description: The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional. ,
Required: False ,
}
{
captureHeaders:
{
Description: For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload. ,
Required: False ,
}
[
string ,
]
,
}
,
rollingRate:
{
Description: When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file. If the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/. If it's day, all data will be collected in blob path /yyyy/MM/dd/. The other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly. ,
Enum:
{
Year: No description available. ,
Month: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Minute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
egressPublicNetworkAccess:
{
Description: If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
endpointComputeType:
{
Description: [Required] The compute type of the endpoint. ,
Enum:
{
Managed: No description available. ,
Kubernetes: No description available. ,
AzureMLCompute: No description available. ,
}
,
Required: True ,
}
enum ,
instanceType:
{
Description: Compute instance type. Default: Standard_F4s_v2. ,
Required: False ,
}
string ,
livenessProbe:
{
Description: Liveness probe monitors the health of the container regularly. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
model:
{
Description: The URI path to the model. ,
Required: False ,
}
string ,
modelMountPath:
{
Description: The path to mount the model in custom container. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the endpoint deployment. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
readinessProbe:
{
Description: Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
startupProbe:
{
Description: Startup probe verify whether an application within a container has started successfully. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
requestSettings:
{
Description: Request settings for the deployment. ,
Required: False ,
}
{
maxConcurrentRequestsPerInstance:
{
Description: The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. ,
Format: int32 ,
Required: False ,
}
integer ,
maxQueueWait:
{
Description: (Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format. Defaults to 500ms. (Now increase `request_timeout_ms` to account for any networking/queue delays) ,
Format: duration ,
Required: False ,
}
string ,
requestTimeout:
{
Description: The scoring timeout in ISO 8601 format. Defaults to 5000ms. ,
Format: duration ,
Required: False ,
}
string ,
}
,
scaleSettings:
{
Description: Scale settings for the deployment. If it is null or not provided, it defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment and to DefaultScaleSettings for ManagedOnlineDeployment. ,
Required: False ,
}
{
scaleType:
{
Description: [Required] Type of deployment scaling algorithm ,
Enum:
{
Default: No description available. ,
TargetUtilization: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-async-operation-timeout:
{
Description: Timeout for the client to use when polling the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for asynchronous operation status. ,
}
string ,
}
,
$schema:
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
appInsightsEnabled:
{
Description: If true, enables Application Insights logging. ,
Required: False ,
}
boolean ,
dataCollector:
{
Description: The mdc configuration, we disable mdc when it's null. ,
Required: False ,
}
{
collections:
{
Description: [Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string. Model data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging. ,
Required: True ,
}
object ,
requestLogging:
{
Description: The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional. ,
Required: False ,
}
{
captureHeaders:
{
Description: For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload. ,
Required: False ,
}
[
string ,
]
,
}
,
rollingRate:
{
Description: When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file. If the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/. If it's day, all data will be collected in blob path /yyyy/MM/dd/. The other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly. ,
Enum:
{
Year: No description available. ,
Month: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Minute: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
egressPublicNetworkAccess:
{
Description: If Enabled, allow egress public network access. If Disabled, this will create secure egress. Default: Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
endpointComputeType:
{
Description: [Required] The compute type of the endpoint. ,
Enum:
{
Managed: No description available. ,
Kubernetes: No description available. ,
AzureMLCompute: No description available. ,
}
,
Required: True ,
}
enum ,
instanceType:
{
Description: Compute instance type. Default: Standard_F4s_v2. ,
Required: False ,
}
string ,
livenessProbe:
{
Description: Liveness probe monitors the health of the container regularly. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
model:
{
Description: The URI path to the model. ,
Required: False ,
}
string ,
modelMountPath:
{
Description: The path to mount the model in custom container. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the endpoint deployment. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
readinessProbe:
{
Description: Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
startupProbe:
{
Description: Startup probe verify whether an application within a container has started successfully. ,
Required: False ,
}
{
failureThreshold:
{
Description: The number of failures to allow before returning an unhealthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
initialDelay:
{
Description: The delay before the first probe in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
period:
{
Description: The length of time between probes in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
successThreshold:
{
Description: The number of successful probes before returning a healthy status. ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: The probe timeout in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
requestSettings:
{
Description: Request settings for the deployment. ,
Required: False ,
}
{
maxConcurrentRequestsPerInstance:
{
Description: The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. ,
Format: int32 ,
Required: False ,
}
integer ,
maxQueueWait:
{
Description: (Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format. Defaults to 500ms. (Now increase `request_timeout_ms` to account for any networking/queue delays) ,
Format: duration ,
Required: False ,
}
string ,
requestTimeout:
{
Description: The scoring timeout in ISO 8601 format. Defaults to 5000ms. ,
Format: duration ,
Required: False ,
}
string ,
}
,
scaleSettings:
{
Description: Scale settings for the deployment. If it is null or not provided, it defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment and to DefaultScaleSettings for ManagedOnlineDeployment. ,
Required: False ,
}
{
scaleType:
{
Description: [Required] Type of deployment scaling algorithm ,
Enum:
{
Default: No description available. ,
TargetUtilization: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}