Environment Containers - Create Or Update

Reference

Service:: Machine Learning

API Version:: 2023-10-01

Create or update container.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}?api-version=2023-10-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Container name. This is case-sensitive. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	Name of Azure Machine Learning workspace. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
properties	True	EnvironmentContainer	[Required] Additional attributes of the entity.

Responses

Name	Type	Description
200 OK	EnvironmentContainerResource	Create or update request is successful.
201 Created	EnvironmentContainerResource	Created
Other Status Codes	ErrorResponse	Error

Examples

CreateOrUpdate Workspace Environment Container.

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment?api-version=2023-10-01

{
  "properties": {
    "properties": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "tags": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "description": "string"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment",
  "name": "testEnvironment",
  "type": "Microsoft.MachineLearningServices/workspaces/environments",
  "properties": {
    "properties": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "tags": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "description": "string"
  },
  "systemData": {
    "createdAt": "2020-12-04T03:39:11.300Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-12-04T03:39:11.300Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/environments/testEnvironment",
  "name": "testEnvironment",
  "type": "Microsoft.MachineLearningServices/workspaces/environments",
  "properties": {
    "properties": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "tags": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "description": "string"
  },
  "systemData": {
    "createdAt": "2020-12-04T03:39:11.301Z",
    "createdBy": "string",
    "createdByType": "User",
    "lastModifiedAt": "2020-12-04T03:39:11.301Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  }
}

Definitions

Name	Description
AssetProvisioningState	Provisioning state of registry asset.
createdByType	The type of identity that created the resource.
EnvironmentContainer	Container for environment specification versions.
EnvironmentContainerResource	Azure Resource Manager resource envelope.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
systemData	Metadata pertaining to creation and last modification of the resource.

AssetProvisioningState

Provisioning state of registry asset.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EnvironmentContainer

Container for environment specification versions.

Name	Type	Default Value	Description
description	string		The asset description text.
isArchived	boolean	False	Is the asset archived?
latestVersion	string		The latest version inside this container.
nextVersion	string		The next auto incremental version
properties	object		The asset property dictionary.
provisioningState	AssetProvisioningState		Provisioning state for the environment container.
tags	object		Tag dictionary. Tags can be added, removed, and updated.

EnvironmentContainerResource

Azure Resource Manager resource envelope.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	EnvironmentContainer	[Required] Additional attributes of the entity.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.