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

2025/02/14 • 280 new methods

Usages_List (new)
Description :  Gets the current usage information as well as limits for AML resources for given subscription and location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The location for which resource usage is queried. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of AML resource usages. ,
Required: False ,
}
[
{
id:
{
Description: Specifies the resource ID. ,
Required: False ,
}
string ,
amlWorkspaceLocation:
{
Description: Region of the AML workspace in the id. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the resource type. ,
Required: False ,
}
string ,
unit:
{
Description: An enum describing the unit of usage measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: False ,
}
enum ,
currentValue:
{
Description: The current usage of the resource. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: The maximum permitted usage of the resource. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: The name of the type of usage. ,
Required: False ,
}
{
value:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of AML resource usage information. Call ListNext() with this to fetch the next page of AML resource usage information. ,
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 ,
}
,
]
,
}
,
}
VirtualMachineSizes_List (new)
Description :  Returns supported VM Sizes in a location
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes
{
location:
{
Description: The location upon which virtual-machine-sizes is queried. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of virtual machine sizes supported by AmlCompute. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine size. ,
Required: False ,
}
string ,
family:
{
Description: The family name of the virtual machine size. ,
Required: False ,
}
string ,
vCPUs:
{
Description: The number of vCPUs supported by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
gpus:
{
Description: The number of gPUs supported by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
osVhdSizeMB:
{
Description: The OS VHD disk size, in MB, allowed by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResourceVolumeMB:
{
Description: The resource volume size, in MB, allowed by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The amount of memory, in GB, supported by the virtual machine size. ,
Format: double ,
Required: False ,
}
number ,
lowPriorityCapable:
{
Description: Specifies if the virtual machine size supports low priority VMs. ,
Required: False ,
}
boolean ,
premiumIO:
{
Description: Specifies if the virtual machine size supports premium IO. ,
Required: False ,
}
boolean ,
estimatedVMPrices:
{
Description: The estimated price information for using a VM. ,
Required: False ,
}
{
billingCurrency:
{
Description: Three lettered code specifying the currency of the VM price. Example: USD ,
Enum:
{
USD: No description available. ,
}
,
Required: True ,
}
enum ,
unitOfMeasure:
{
Description: The unit of time measurement for the specified VM price. Example: OneHour ,
Enum:
{
OneHour: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: The list of estimated prices for using a VM of a particular OS type, tier, etc. ,
Required: True ,
}
[
{
retailPrice:
{
Description: The price charged for using the VM. ,
Format: double ,
Required: True ,
}
number ,
osType:
{
Description: Operating system type used by the VM. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
vmTier:
{
Description: The type of the VM. ,
Enum:
{
Standard: No description available. ,
LowPriority: No description available. ,
Spot: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
supportedComputeTypes:
{
Description: Specifies the compute types supported by the virtual machine size. ,
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 ,
}
,
]
,
}
,
}
Quotas_Update (new)
Description :  Update quota for each VM family in workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/updateQuotas
{
location:
{
Description: The location for update quota is queried. ,
Required: True ,
}
string ,
parameters:
{
Description: Quota update parameters. ,
Required: True ,
}
{
value:
{
Description: The list for update quota. ,
Required: False ,
}
[
{
id:
{
Description: Specifies the resource ID. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the resource type. ,
Required: False ,
}
string ,
limit:
{
Description: The maximum permitted quota of the resource. ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: An enum describing the unit of quota measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
location:
{
Description: Region of workspace quota to be updated. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of workspace quota update result. ,
Required: False ,
}
[
{
id:
{
Description: Specifies the resource ID. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the resource type. ,
Required: False ,
}
string ,
limit:
{
Description: The maximum permitted quota of the resource. ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: An enum describing the unit of quota measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of update workspace quota. ,
Enum:
{
Undefined: No description available. ,
Success: No description available. ,
Failure: No description available. ,
InvalidQuotaBelowClusterMinimum: No description available. ,
InvalidQuotaExceedsSubscriptionLimit: No description available. ,
InvalidVMFamilyName: No description available. ,
OperationNotSupportedForSku: No description available. ,
OperationNotEnabledForRegion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of workspace quota update result. Call ListNext() with this to fetch the next page of Workspace Quota update result. ,
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 ,
}
,
]
,
}
,
}
Quotas_List (new)
Description :  Gets the currently assigned Workspace Quotas based on VMFamily.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/quotas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The location for which resource usage is queried. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Workspace Quotas by VM Family ,
Required: False ,
}
[
{
id:
{
Description: Specifies the resource ID. ,
Required: False ,
}
string ,
amlWorkspaceLocation:
{
Description: Region of the AML workspace in the id. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the resource type. ,
Required: False ,
}
string ,
name:
{
Description: Name of the resource. ,
Required: False ,
}
{
value:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
localizedValue:
{
Description: The localized name of the resource. ,
Required: False ,
}
string ,
}
,
limit:
{
Description: The maximum permitted quota of the resource. ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: An enum describing the unit of quota measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of workspace quota information by VM Family. Call ListNext() with this to fetch the next page of Workspace Quota information. ,
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 ,
}
,
]
,
}
,
}
Compute_List (new)
Description :  Gets computes in specified workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Machine Learning compute objects wrapped in ARM resource envelope. ,
Required: False ,
}
[
{
identity:
{
Description: The identity of the resource. ,
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 ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: A continuation link (absolute URI) to the next page of results in the list. ,
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 ,
}
,
]
,
}
,
}
Compute_Get (new)
Description :  Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The identity of the resource. ,
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 ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
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 ,
}
,
]
,
}
,
}
Compute_CreateOrUpdate (new)
Description :  Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Payload with Machine Learning compute definition. ,
Required: True ,
}
{
identity:
{
Description: The identity of the resource. ,
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 ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
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: The identity of the resource. ,
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 ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
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:
{
azure-asyncoperation:
{
Description: URI to poll for asynchronous operation status. ,
}
string ,
}
,
$schema:
{
Description: Machine Learning compute object wrapped into ARM resource envelope. ,
}
{
identity:
{
Description: The identity of the resource. ,
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 ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
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 ,
}
,
]
,
}
,
}
Compute_Update (new)
Description :  Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters for cluster update. ,
Required: True ,
}
{
properties:
{
Description: The properties of the amlCompute. ,
Required: False ,
}
{
properties:
{
Description: Properties of ClusterUpdate ,
Required: False ,
}
{
scaleSettings:
{
Description: scale settings for AML Compute ,
Required: False ,
}
{
maxNodeCount:
{
Description: Max number of nodes to use ,
Format: int32 ,
Required: True ,
}
integer ,
minNodeCount:
{
Description: Min number of nodes to use ,
Format: int32 ,
Required: False ,
}
integer ,
nodeIdleTimeBeforeScaleDown:
{
Description: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The identity of the resource. ,
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 ,
}
,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Contains resource tags defined as key/value pairs. ,
Required: False ,
}
object ,
sku:
{
Description: The sku of the workspace. ,
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 ,
}
,
]
,
}
,
}
Compute_Delete (new)
Description :  Deletes specified Machine Learning compute.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
underlyingResourceAction:
{
Description: Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URI to poll for asynchronous operation status. ,
}
string ,
location:
{
Description: URI to poll for asynchronous operation result. ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Compute_UpdateCustomServices (new)
Description :  Updates the custom services list. The list of custom services provided shall be overwritten
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/customServices
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
customServices:
{
Description: New list of Custom Services. ,
Required: True ,
}
{
name:
{
Description: Name of the Custom Service ,
Required: False ,
}
string ,
image:
{
Description: Describes the Image Specifications ,
Required: False ,
}
{
type:
{
Description: Type of the image. Possible values are: docker - For docker images. azureml - For AzureML Environment images (custom and curated) ,
Enum:
{
docker: No description available. ,
azureml: No description available. ,
}
,
Required: False ,
}
enum ,
reference:
{
Description: Image reference URL if type is docker. Environment name if type is azureml ,
Required: False ,
}
string ,
version:
{
Description: Version of image being used. If latest then skip this field ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment Variable for the container ,
Required: False ,
}
object ,
docker:
{
Description: Describes the docker settings for the image ,
Required: False ,
}
{
privileged:
{
Description: Indicate whether container shall run in privileged or non-privileged mode. ,
Required: False ,
}
boolean ,
}
,
endpoints:
{
Description: Configuring the endpoints for the container ,
Required: False ,
}
[
{
protocol:
{
Description: Protocol over which communication will happen over this endpoint ,
Enum:
{
tcp: No description available. ,
udp: No description available. ,
http: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the Endpoint ,
Required: False ,
}
string ,
target:
{
Description: Application port inside the container. ,
Format: int32 ,
Required: False ,
}
integer ,
published:
{
Description: Port over which the application is exposed from container. ,
Format: int32 ,
Required: False ,
}
integer ,
hostIp:
{
Description: Host IP over which the application is exposed from the container ,
Required: False ,
}
string ,
}
,
]
,
volumes:
{
Description: Configuring the volumes for the container ,
Required: False ,
}
[
{
type:
{
Description: Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe ,
Enum:
{
bind: No description available. ,
volume: No description available. ,
tmpfs: No description available. ,
npipe: No description available. ,
}
,
Required: False ,
}
enum ,
readOnly:
{
Description: Indicate whether to mount volume as readOnly. Default value for this is false. ,
Required: False ,
}
boolean ,
source:
{
Description: Source of the mount. For bind mounts this is the host path. ,
Required: False ,
}
string ,
target:
{
Description: Target of the mount. For bind mounts this is the path in the container. ,
Required: False ,
}
string ,
consistency:
{
Description: Consistency of the volume ,
Required: False ,
}
string ,
bind:
{
Description: Bind Options of the mount ,
Required: False ,
}
{
propagation:
{
Description: Type of Bind Option ,
Required: False ,
}
string ,
createHostPath:
{
Description: Indicate whether to create host path. ,
Required: False ,
}
boolean ,
selinux:
{
Description: Mention the selinux options. ,
Required: False ,
}
string ,
}
,
volume:
{
Description: Volume Options of the mount ,
Required: False ,
}
{
nocopy:
{
Description: Indicate whether volume is nocopy ,
Required: False ,
}
boolean ,
}
,
tmpfs:
{
Description: tmpfs option of the mount ,
Required: False ,
}
{
size:
{
Description: Mention the Tmpfs size ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
kernel:
{
Description: Describes the jupyter kernel settings for the image if its a custom environment ,
Required: False ,
}
{
argv:
{
Description: Argument to the the runtime ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: Display name of the kernel ,
Required: False ,
}
string ,
language:
{
Description: Language of the kernel [Example value: python] ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Compute_ListNodes (new)
Description :  Get the details (e.g IP address, port etc) of all the compute nodes in the compute.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nodes:
{
Description: The collection of returned AmlCompute nodes details. ,
Required: False ,
}
[
{
nodeId:
{
Description: ID of the compute node. ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: Private IP address of the compute node. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: Public IP address of the compute node. ,
Required: False ,
}
string ,
port:
{
Description: SSH port number of the node. ,
Format: int32 ,
Required: False ,
}
number ,
nodeState:
{
Description: State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. ,
Enum:
{
idle: No description available. ,
running: No description available. ,
preparing: No description available. ,
unusable: No description available. ,
leaving: No description available. ,
preempted: No description available. ,
}
,
Required: False ,
}
enum ,
runId:
{
Description: ID of the Experiment running on the node, if any else null. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The continuation token. ,
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 ,
}
,
]
,
}
,
}
Compute_ListKeys (new)
Description :  Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
computeType:
{
Description: The type of compute ,
Enum:
{
AKS: No description available. ,
Kubernetes: No description available. ,
AmlCompute: No description available. ,
ComputeInstance: No description available. ,
DataFactory: No description available. ,
VirtualMachine: No description available. ,
HDInsight: No description available. ,
Databricks: No description available. ,
DataLakeAnalytics: No description available. ,
SynapseSpark: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Compute_UpdateDataMounts (new)
Description :  Update Data Mounts of a Machine Learning compute.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/updateDataMounts
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dataMounts:
{
Description: The parameters for creating or updating a machine learning workspace. ,
Required: True ,
}
{
source:
{
Description: Source of the ComputeInstance data mount. ,
Required: False ,
}
string ,
sourceType:
{
Description: Data source type. ,
Enum:
{
Dataset: No description available. ,
Datastore: No description available. ,
URI: No description available. ,
}
,
Required: False ,
}
enum ,
mountName:
{
Description: name of the ComputeInstance data mount. ,
Required: False ,
}
string ,
mountAction:
{
Description: Mount Action. ,
Enum:
{
Mount: No description available. ,
Unmount: No description available. ,
}
,
Required: False ,
}
enum ,
mountMode:
{
Description: Mount Mode. ,
Enum:
{
ReadOnly: No description available. ,
ReadWrite: No description available. ,
}
,
Required: False ,
}
enum ,
createdBy:
{
Description: who this data mount created by. ,
Required: False ,
}
string ,
mountPath:
{
Description: Path of this data mount. ,
Required: False ,
}
string ,
mountState:
{
Description: Mount state. ,
Enum:
{
MountRequested: No description available. ,
Mounted: No description available. ,
MountFailed: No description available. ,
UnmountRequested: No description available. ,
UnmountFailed: No description available. ,
Unmounted: No description available. ,
}
,
Required: False ,
}
enum ,
mountedOn:
{
Description: The time when the disk mounted. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error of this data mount. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Compute_Start (new)
Description :  Posts a start action to a compute instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/start
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Compute_Stop (new)
Description :  Posts a stop action to a compute instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/stop
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Compute_Restart (new)
Description :  Posts a restart action to a compute instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/restart
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Compute_UpdateIdleShutdownSetting (new)
Description :  Updates the idle shutdown setting of a compute instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/updateIdleShutdownSetting
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The object for updating idle shutdown setting of specified ComputeInstance. ,
Required: True ,
}
{
idleTimeBeforeShutdown:
{
Description: Time is defined in ISO8601 format. Minimum is 15 min, maximum is 3 days. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Compute_getAllowedResizeSizes (new)
Description :  Returns supported virtual machine sizes for resize
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/getAllowedVmSizesForResize
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of virtual machine sizes supported by AmlCompute. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine size. ,
Required: False ,
}
string ,
family:
{
Description: The family name of the virtual machine size. ,
Required: False ,
}
string ,
vCPUs:
{
Description: The number of vCPUs supported by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
gpus:
{
Description: The number of gPUs supported by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
osVhdSizeMB:
{
Description: The OS VHD disk size, in MB, allowed by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResourceVolumeMB:
{
Description: The resource volume size, in MB, allowed by the virtual machine size. ,
Format: int32 ,
Required: False ,
}
integer ,
memoryGB:
{
Description: The amount of memory, in GB, supported by the virtual machine size. ,
Format: double ,
Required: False ,
}
number ,
lowPriorityCapable:
{
Description: Specifies if the virtual machine size supports low priority VMs. ,
Required: False ,
}
boolean ,
premiumIO:
{
Description: Specifies if the virtual machine size supports premium IO. ,
Required: False ,
}
boolean ,
estimatedVMPrices:
{
Description: The estimated price information for using a VM. ,
Required: False ,
}
{
billingCurrency:
{
Description: Three lettered code specifying the currency of the VM price. Example: USD ,
Enum:
{
USD: No description available. ,
}
,
Required: True ,
}
enum ,
unitOfMeasure:
{
Description: The unit of time measurement for the specified VM price. Example: OneHour ,
Enum:
{
OneHour: No description available. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: The list of estimated prices for using a VM of a particular OS type, tier, etc. ,
Required: True ,
}
[
{
retailPrice:
{
Description: The price charged for using the VM. ,
Format: double ,
Required: True ,
}
number ,
osType:
{
Description: Operating system type used by the VM. ,
Enum:
{
Linux: No description available. ,
Windows: No description available. ,
}
,
Required: True ,
}
enum ,
vmTier:
{
Description: The type of the VM. ,
Enum:
{
Standard: No description available. ,
LowPriority: No description available. ,
Spot: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
supportedComputeTypes:
{
Description: Specifies the compute types supported by the virtual machine size. ,
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 ,
}
,
]
,
}
,
}
Compute_Resize (new)
Description :  Updates the size of a Compute Instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/resize
{
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 ,
computeName:
{
Description: Name of the Azure Machine Learning compute. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The object for updating VM size setting of specified Compute Instance. ,
Required: True ,
}
{
targetVMSize:
{
Description: The name of the virtual machine size. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
PTUQuota_ListAvailable (new)
Description :  List available MaaS PTU quota.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/availableQuota
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of AvailableQuota objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type AvailableQuota. ,
Required: False ,
}
[
{
properties:
{
Description: Available quota properties ,
Required: False ,
}
{
total:
{
Description: The number of available quota ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
PTUQuota_GetAvailable (new)
Description :  Get available MaaS PTU quota.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/availableQuota/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Available quota properties ,
Required: False ,
}
{
total:
{
Description: The number of available quota ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
PTUQuota_List (new)
Description :  List MaaS PTU usage and quota.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/quotaAndUsage
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The name of Azure region. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of UsageAndQuotaDetails objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type UsageAndQuotaDetails. ,
Required: False ,
}
[
{
modelCollection:
{
Description: Model collection name ,
Required: False ,
}
string ,
quota:
{
Description: The total number of quota ,
Format: int64 ,
Required: False ,
}
integer ,
usageDetails:
{
Description: Usage details for each deployment ,
Required: False ,
}
[
{
collectionQuotaUsage:
{
Description: Usage number from the collection level quota ,
Format: int64 ,
Required: False ,
}
integer ,
deploymentName:
{
Description: Deployment name ,
Required: False ,
}
string ,
resourceGroup:
{
Description: Resource group name ,
Required: False ,
}
string ,
usage:
{
Description: Usage number from subscription level quota ,
Format: int64 ,
Required: False ,
}
integer ,
workspaceName:
{
Description: Workspace name ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
RegistryCodeContainers_List (new)
Description :  List containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of CodeContainer objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type CodeContainer. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the code container. ,
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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryCodeContainers_Delete (new)
Description :  Delete Code container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}
{
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 ,
codeName:
{
Description: Container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryCodeContainers_Get (new)
Description :  Get Code container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}
{
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 ,
codeName:
{
Description: Container name. ,
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 ,
}
{
provisioningState:
{
Description: Provisioning state for the code container. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryCodeContainers_CreateOrUpdate (new)
Description :  Create or update Code container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}
{
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 ,
codeName:
{
Description: Container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Container entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the code container. ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the code container. ,
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 ,
}
,
}

⚐ 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 ,
}
{
provisioningState:
{
Description: Provisioning state for the code container. ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryCodeVersions_List (new)
Description :  List versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/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 ,
codeName:
{
Description: Container 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: Maximum number of records to return. ,
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 CodeVersion objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type CodeVersion. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
codeUri:
{
Description: Uri where code is located ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the code 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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryCodeVersions_Delete (new)
Description :  Delete version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/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 ,
codeName:
{
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 ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryCodeVersions_Get (new)
Description :  Get version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/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 ,
codeName:
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
codeUri:
{
Description: Uri where code is located ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the code 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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryCodeVersions_CreateOrUpdate (new)
Description :  Create or update version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/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 ,
codeName:
{
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 ,
}
{
codeUri:
{
Description: Uri where code is located ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the code 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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
codeUri:
{
Description: Uri where code is located ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the code 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 ,
}
,
}

⚐ 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 ,
}
{
codeUri:
{
Description: Uri where code is located ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the code 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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryCodeVersions_CreateOrGetStartPendingUpload (new)
Description :  Generate a storage location and credential for the client to upload a code asset to.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}/startPendingUpload
{
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 ,
codeName:
{
Description: Pending upload 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 ,
body:
{
Description: Pending upload request object ,
Required: True ,
}
{
pendingUploadId:
{
Description: If PendingUploadId = null then random guid will be used. ,
Required: False ,
}
string ,
pendingUploadType:
{
Description: TemporaryBlobReference is the only supported type ,
Enum:
{
None: No description available. ,
TemporaryBlobReference: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
blobReferenceForConsumption:
{
Description: Container level read, write, list SAS ,
Required: False ,
}
{
blobUri:
{
Description: Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path ,
Format: uri ,
Required: False ,
}
string ,
credential:
{
Description: Credential info to access storage account ,
Required: False ,
}
{
credentialType:
{
Description: [Required] Credential type used to authentication with storage. ,
Enum:
{
SAS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
storageAccountArmId:
{
Description: Arm ID of the storage account to use ,
Required: False ,
}
string ,
}
,
pendingUploadId:
{
Description: ID for this upload request ,
Required: False ,
}
string ,
pendingUploadType:
{
Description: TemporaryBlobReference is the only supported type ,
Enum:
{
None: No description available. ,
TemporaryBlobReference: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryComponentContainers_List (new)
Description :  List containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of ComponentContainer objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type ComponentContainer. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the component container. ,
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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryComponentContainers_Delete (new)
Description :  Delete container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}
{
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 ,
componentName:
{
Description: Container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryComponentContainers_Get (new)
Description :  Get container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}
{
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 ,
componentName:
{
Description: Container name. ,
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 ,
}
{
provisioningState:
{
Description: Provisioning state for the component container. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryComponentContainers_CreateOrUpdate (new)
Description :  Create or update container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}
{
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 ,
componentName:
{
Description: Container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Container entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the component container. ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the component container. ,
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 ,
}
,
}

⚐ 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 ,
}
{
provisioningState:
{
Description: Provisioning state for the component container. ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryComponentVersions_List (new)
Description :  List versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/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 ,
componentName:
{
Description: Container 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: Maximum number of records to return. ,
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 ComponentVersion objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type ComponentVersion. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
componentSpec:
{
Description: Defines Component definition details. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state for the component 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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryComponentVersions_Delete (new)
Description :  Delete version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/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 ,
componentName:
{
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 ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryComponentVersions_Get (new)
Description :  Get version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/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 ,
componentName:
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
componentSpec:
{
Description: Defines Component definition details. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state for the component 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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryComponentVersions_CreateOrUpdate (new)
Description :  Create or update version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/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 ,
componentName:
{
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 ,
}
{
componentSpec:
{
Description: Defines Component definition details. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state for the component 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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
componentSpec:
{
Description: Defines Component definition details. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state for the component 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 ,
}
,
}

⚐ 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 ,
}
{
componentSpec:
{
Description: Defines Component definition details. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state for the component 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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryDataContainers_List (new)
Description :  List Data containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$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 DataContainer objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type DataContainer. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryDataContainers_Delete (new)
Description :  Delete container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}
{
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 ,
name:
{
Description: Container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryDataContainers_Get (new)
Description :  Get container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}
{
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 ,
name:
{
Description: Container name. ,
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 ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryDataContainers_CreateOrUpdate (new)
Description :  Create or update container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}
{
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 ,
name:
{
Description: Container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Container entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ 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 ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryDataVersions_List (new)
Description :  List data versions in the data container
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{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 ,
registryName:
{
Description: Name of Azure Machine Learning registry. This is case-insensitive ,
Required: True ,
}
string ,
name:
{
Description: Data container's name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$orderBy:
{
Description: Please choose OrderBy value from ['createdtime', 'modifiedtime'] ,
Required: False ,
}
string ,
$top:
{
Description: Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
$tags:
{
Description: Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2 ,
Required: False ,
}
string ,
listViewType:
{
Description: [ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of DataVersionBase objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type DataVersionBase. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
dataUri:
{
Description: [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
RegistryDataVersions_Delete (new)
Description :  Delete version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{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 ,
registryName:
{
Description: Name of Azure Machine Learning registry. This is case-insensitive ,
Required: True ,
}
string ,
name:
{
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 ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryDataVersions_Get (new)
Description :  Get version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{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 ,
registryName:
{
Description: Name of Azure Machine Learning registry. This is case-insensitive ,
Required: True ,
}
string ,
name:
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
dataUri:
{
Description: [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
RegistryDataVersions_CreateOrUpdate (new)
Description :  Create or update version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{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 ,
registryName:
{
Description: Name of Azure Machine Learning registry. This is case-insensitive ,
Required: True ,
}
string ,
name:
{
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 ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
dataUri:
{
Description: [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
dataUri:
{
Description: [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
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 ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
dataUri:
{
Description: [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
RegistryDataVersions_CreateOrGetStartPendingUpload (new)
Description :  Generate a storage location and credential for the client to upload a data asset to.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}/startPendingUpload
{
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 ,
name:
{
Description: Data asset 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 ,
body:
{
Description: Pending upload request object ,
Required: True ,
}
{
pendingUploadId:
{
Description: If PendingUploadId = null then random guid will be used. ,
Required: False ,
}
string ,
pendingUploadType:
{
Description: TemporaryBlobReference is the only supported type ,
Enum:
{
None: No description available. ,
TemporaryBlobReference: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
blobReferenceForConsumption:
{
Description: Container level read, write, list SAS ,
Required: False ,
}
{
blobUri:
{
Description: Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path ,
Format: uri ,
Required: False ,
}
string ,
credential:
{
Description: Credential info to access storage account ,
Required: False ,
}
{
credentialType:
{
Description: [Required] Credential type used to authentication with storage. ,
Enum:
{
SAS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
storageAccountArmId:
{
Description: Arm ID of the storage account to use ,
Required: False ,
}
string ,
}
,
pendingUploadId:
{
Description: ID for this upload request ,
Required: False ,
}
string ,
pendingUploadType:
{
Description: TemporaryBlobReference is the only supported type ,
Enum:
{
None: No description available. ,
TemporaryBlobReference: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryDataReferences_GetBlobReferenceSAS (new)
Description :  Get blob reference SAS Uri.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/datareferences/{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 ,
registryName:
{
Description: Name of Azure Machine Learning registry. This is case-insensitive ,
Required: True ,
}
string ,
name:
{
Description: Data reference 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: Asset id and blob uri. ,
Required: True ,
}
{
assetId:
{
Description: Id of the asset to be accessed ,
Required: False ,
}
string ,
blobUri:
{
Description: Blob uri of the asset to be accessed ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
blobReferenceForConsumption:
{
Description: Blob reference for consumption details ,
Required: False ,
}
{
blobUri:
{
Description: Blob uri, example: https://blob.windows.core.net/Container/Path ,
Format: uri ,
Required: False ,
}
string ,
credential:
{
Description: Credential info to access storage account ,
Required: False ,
}
{
credentialType:
{
Description: [Required] Credential type used to authentication with storage. ,
Enum:
{
SAS: No description available. ,
DockerCredentials: No description available. ,
ManagedIdentity: No description available. ,
NoCredentials: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
storageAccountArmId:
{
Description: The ARM id of the storage account ,
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 ,
}
,
]
,
}
,
}
RegistryEnvironmentContainers_List (new)
Description :  List environment containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$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 EnvironmentContainer objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type EnvironmentContainer. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the environment container. ,
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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryEnvironmentContainers_Delete (new)
Description :  Delete container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryEnvironmentContainers_Get (new)
Description :  Get container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the environment container. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryEnvironmentContainers_CreateOrUpdate (new)
Description :  Create or update container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Container entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the environment container. ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the environment container. ,
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 ,
}
,
}

⚐ 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 ,
}
{
provisioningState:
{
Description: Provisioning state for the environment container. ,
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 ,
}
,
}
,
}

⚐ 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_List (new)
Description :  List versions.
Reference :  Link ¶

⚼ 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 ,
imageDetails:
{
Description: Environment image details ,
Required: False ,
}
{
exists:
{
Description: Indicates if image exists ,
Required: False ,
}
boolean ,
image:
{
Description: Container image details ,
Required: False ,
}
{
digest:
{
Description: Image digest ,
Required: False ,
}
string ,
hostname:
{
Description: Container registry host name ,
Required: False ,
}
string ,
repository:
{
Description: Repository name ,
Required: False ,
}
string ,
tag:
{
Description: Image tag ,
Required: False ,
}
string ,
}
,
vulnerabilityFindings:
{
Description: Vulnerability findings details ,
Required: False ,
}
{
assetId:
{
Description: AssetId (Image digest). ,
Required: False ,
}
string ,
criticalFindingsCount:
{
Description: Number of critical findings. ,
Format: int32 ,
Required: False ,
}
integer ,
data:
{
Description: List of vulnerability findings. ,
Required: False ,
}
[
{
cve:
{
Description: CVE id. ,
Required: False ,
}
string ,
cveUrl:
{
Description: CVE url. ,
Required: False ,
}
string ,
dueDate:
{
Description: DueDate for vulnerability. Provider data or PublishDate + 30 days. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Vulnerability ID. ,
Required: False ,
}
string ,
packageDetails:
{
Description: Dependency details. ,
Required: False ,
}
[
{
installPath:
{
Description: Install path. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Installed version. ,
Required: False ,
}
string ,
name:
{
Description: Package or dependency name. ,
Required: False ,
}
string ,
patchedVersion:
{
Description: Patched version. ,
Required: False ,
}
string ,
}
,
]
,
patchable:
{
Description: Indicates if there is a known patch for vulnerability. ,
Required: False ,
}
boolean ,
providerId:
{
Description: Vulnerability ID from provider. ,
Required: False ,
}
string ,
publishDate:
{
Description: Vulnerability publish date. ,
Format: date-time ,
Required: False ,
}
string ,
risk:
{
Description: Vulnerability Risk value. ,
Enum:
{
UNKNOWN: No description available. ,
CRITICAL: No description available. ,
HIGH: No description available. ,
MEDIUM: No description available. ,
LOW: No description available. ,
}
,
Required: False ,
}
enum ,
solution:
{
Description: Vulnerability description. ,
Required: False ,
}
string ,
title:
{
Description: Vulnerability name. ,
Required: False ,
}
string ,
vendorId:
{
Description: Vendor vulnerability ID (USN, GH Advisory, etc). ,
Required: False ,
}
string ,
vendorUrl:
{
Description: Vendor vulnerability url. ,
Required: False ,
}
string ,
}
,
]
,
generatedTime:
{
Description: Time the report was generated. ,
Format: date-time ,
Required: False ,
}
string ,
highFindingsCount:
{
Description: Number of high findings. ,
Format: int32 ,
Required: False ,
}
integer ,
lastScanDate:
{
Description: Scan result date. ,
Format: date-time ,
Required: False ,
}
string ,
scanner:
{
Description: Vulnerability scanner name. ,
Required: False ,
}
string ,
source:
{
Description: Data source (internal). ,
Required: False ,
}
string ,
totalFindingsCount:
{
Description: Total findings count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
}
,
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_Delete (new)
Description :  Delete version.
Reference :  Link ¶

⚼ Request

DELETE:  /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 ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 (new)
Description :  Get version.
Reference :  Link ¶

⚼ 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 ,
imageDetails:
{
Description: Environment image details ,
Required: False ,
}
{
exists:
{
Description: Indicates if image exists ,
Required: False ,
}
boolean ,
image:
{
Description: Container image details ,
Required: False ,
}
{
digest:
{
Description: Image digest ,
Required: False ,
}
string ,
hostname:
{
Description: Container registry host name ,
Required: False ,
}
string ,
repository:
{
Description: Repository name ,
Required: False ,
}
string ,
tag:
{
Description: Image tag ,
Required: False ,
}
string ,
}
,
vulnerabilityFindings:
{
Description: Vulnerability findings details ,
Required: False ,
}
{
assetId:
{
Description: AssetId (Image digest). ,
Required: False ,
}
string ,
criticalFindingsCount:
{
Description: Number of critical findings. ,
Format: int32 ,
Required: False ,
}
integer ,
data:
{
Description: List of vulnerability findings. ,
Required: False ,
}
[
{
cve:
{
Description: CVE id. ,
Required: False ,
}
string ,
cveUrl:
{
Description: CVE url. ,
Required: False ,
}
string ,
dueDate:
{
Description: DueDate for vulnerability. Provider data or PublishDate + 30 days. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Vulnerability ID. ,
Required: False ,
}
string ,
packageDetails:
{
Description: Dependency details. ,
Required: False ,
}
[
{
installPath:
{
Description: Install path. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Installed version. ,
Required: False ,
}
string ,
name:
{
Description: Package or dependency name. ,
Required: False ,
}
string ,
patchedVersion:
{
Description: Patched version. ,
Required: False ,
}
string ,
}
,
]
,
patchable:
{
Description: Indicates if there is a known patch for vulnerability. ,
Required: False ,
}
boolean ,
providerId:
{
Description: Vulnerability ID from provider. ,
Required: False ,
}
string ,
publishDate:
{
Description: Vulnerability publish date. ,
Format: date-time ,
Required: False ,
}
string ,
risk:
{
Description: Vulnerability Risk value. ,
Enum:
{
UNKNOWN: No description available. ,
CRITICAL: No description available. ,
HIGH: No description available. ,
MEDIUM: No description available. ,
LOW: No description available. ,
}
,
Required: False ,
}
enum ,
solution:
{
Description: Vulnerability description. ,
Required: False ,
}
string ,
title:
{
Description: Vulnerability name. ,
Required: False ,
}
string ,
vendorId:
{
Description: Vendor vulnerability ID (USN, GH Advisory, etc). ,
Required: False ,
}
string ,
vendorUrl:
{
Description: Vendor vulnerability url. ,
Required: False ,
}
string ,
}
,
]
,
generatedTime:
{
Description: Time the report was generated. ,
Format: date-time ,
Required: False ,
}
string ,
highFindingsCount:
{
Description: Number of high findings. ,
Format: int32 ,
Required: False ,
}
integer ,
lastScanDate:
{
Description: Scan result date. ,
Format: date-time ,
Required: False ,
}
string ,
scanner:
{
Description: Vulnerability scanner name. ,
Required: False ,
}
string ,
source:
{
Description: Data source (internal). ,
Required: False ,
}
string ,
totalFindingsCount:
{
Description: Total findings count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
}
,
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 (new)
Description :  Create or update version.
Reference :  Link ¶

⚼ 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 ,
imageDetails:
{
Description: Environment image details ,
Required: False ,
}
{
exists:
{
Description: Indicates if image exists ,
Required: False ,
}
boolean ,
image:
{
Description: Container image details ,
Required: False ,
}
{
digest:
{
Description: Image digest ,
Required: False ,
}
string ,
hostname:
{
Description: Container registry host name ,
Required: False ,
}
string ,
repository:
{
Description: Repository name ,
Required: False ,
}
string ,
tag:
{
Description: Image tag ,
Required: False ,
}
string ,
}
,
vulnerabilityFindings:
{
Description: Vulnerability findings details ,
Required: False ,
}
{
assetId:
{
Description: AssetId (Image digest). ,
Required: False ,
}
string ,
criticalFindingsCount:
{
Description: Number of critical findings. ,
Format: int32 ,
Required: False ,
}
integer ,
data:
{
Description: List of vulnerability findings. ,
Required: False ,
}
[
{
cve:
{
Description: CVE id. ,
Required: False ,
}
string ,
cveUrl:
{
Description: CVE url. ,
Required: False ,
}
string ,
dueDate:
{
Description: DueDate for vulnerability. Provider data or PublishDate + 30 days. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Vulnerability ID. ,
Required: False ,
}
string ,
packageDetails:
{
Description: Dependency details. ,
Required: False ,
}
[
{
installPath:
{
Description: Install path. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Installed version. ,
Required: False ,
}
string ,
name:
{
Description: Package or dependency name. ,
Required: False ,
}
string ,
patchedVersion:
{
Description: Patched version. ,
Required: False ,
}
string ,
}
,
]
,
patchable:
{
Description: Indicates if there is a known patch for vulnerability. ,
Required: False ,
}
boolean ,
providerId:
{
Description: Vulnerability ID from provider. ,
Required: False ,
}
string ,
publishDate:
{
Description: Vulnerability publish date. ,
Format: date-time ,
Required: False ,
}
string ,
risk:
{
Description: Vulnerability Risk value. ,
Enum:
{
UNKNOWN: No description available. ,
CRITICAL: No description available. ,
HIGH: No description available. ,
MEDIUM: No description available. ,
LOW: No description available. ,
}
,
Required: False ,
}
enum ,
solution:
{
Description: Vulnerability description. ,
Required: False ,
}
string ,
title:
{
Description: Vulnerability name. ,
Required: False ,
}
string ,
vendorId:
{
Description: Vendor vulnerability ID (USN, GH Advisory, etc). ,
Required: False ,
}
string ,
vendorUrl:
{
Description: Vendor vulnerability url. ,
Required: False ,
}
string ,
}
,
]
,
generatedTime:
{
Description: Time the report was generated. ,
Format: date-time ,
Required: False ,
}
string ,
highFindingsCount:
{
Description: Number of high findings. ,
Format: int32 ,
Required: False ,
}
integer ,
lastScanDate:
{
Description: Scan result date. ,
Format: date-time ,
Required: False ,
}
string ,
scanner:
{
Description: Vulnerability scanner name. ,
Required: False ,
}
string ,
source:
{
Description: Data source (internal). ,
Required: False ,
}
string ,
totalFindingsCount:
{
Description: Total findings count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
}
,
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 ,
imageDetails:
{
Description: Environment image details ,
Required: False ,
}
{
exists:
{
Description: Indicates if image exists ,
Required: False ,
}
boolean ,
image:
{
Description: Container image details ,
Required: False ,
}
{
digest:
{
Description: Image digest ,
Required: False ,
}
string ,
hostname:
{
Description: Container registry host name ,
Required: False ,
}
string ,
repository:
{
Description: Repository name ,
Required: False ,
}
string ,
tag:
{
Description: Image tag ,
Required: False ,
}
string ,
}
,
vulnerabilityFindings:
{
Description: Vulnerability findings details ,
Required: False ,
}
{
assetId:
{
Description: AssetId (Image digest). ,
Required: False ,
}
string ,
criticalFindingsCount:
{
Description: Number of critical findings. ,
Format: int32 ,
Required: False ,
}
integer ,
data:
{
Description: List of vulnerability findings. ,
Required: False ,
}
[
{
cve:
{
Description: CVE id. ,
Required: False ,
}
string ,
cveUrl:
{
Description: CVE url. ,
Required: False ,
}
string ,
dueDate:
{
Description: DueDate for vulnerability. Provider data or PublishDate + 30 days. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Vulnerability ID. ,
Required: False ,
}
string ,
packageDetails:
{
Description: Dependency details. ,
Required: False ,
}
[
{
installPath:
{
Description: Install path. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Installed version. ,
Required: False ,
}
string ,
name:
{
Description: Package or dependency name. ,
Required: False ,
}
string ,
patchedVersion:
{
Description: Patched version. ,
Required: False ,
}
string ,
}
,
]
,
patchable:
{
Description: Indicates if there is a known patch for vulnerability. ,
Required: False ,
}
boolean ,
providerId:
{
Description: Vulnerability ID from provider. ,
Required: False ,
}
string ,
publishDate:
{
Description: Vulnerability publish date. ,
Format: date-time ,
Required: False ,
}
string ,
risk:
{
Description: Vulnerability Risk value. ,
Enum:
{
UNKNOWN: No description available. ,
CRITICAL: No description available. ,
HIGH: No description available. ,
MEDIUM: No description available. ,
LOW: No description available. ,
}
,
Required: False ,
}
enum ,
solution:
{
Description: Vulnerability description. ,
Required: False ,
}
string ,
title:
{
Description: Vulnerability name. ,
Required: False ,
}
string ,
vendorId:
{
Description: Vendor vulnerability ID (USN, GH Advisory, etc). ,
Required: False ,
}
string ,
vendorUrl:
{
Description: Vendor vulnerability url. ,
Required: False ,
}
string ,
}
,
]
,
generatedTime:
{
Description: Time the report was generated. ,
Format: date-time ,
Required: False ,
}
string ,
highFindingsCount:
{
Description: Number of high findings. ,
Format: int32 ,
Required: False ,
}
integer ,
lastScanDate:
{
Description: Scan result date. ,
Format: date-time ,
Required: False ,
}
string ,
scanner:
{
Description: Vulnerability scanner name. ,
Required: False ,
}
string ,
source:
{
Description: Data source (internal). ,
Required: False ,
}
string ,
totalFindingsCount:
{
Description: Total findings count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
}
,
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 ,
imageDetails:
{
Description: Environment image details ,
Required: False ,
}
{
exists:
{
Description: Indicates if image exists ,
Required: False ,
}
boolean ,
image:
{
Description: Container image details ,
Required: False ,
}
{
digest:
{
Description: Image digest ,
Required: False ,
}
string ,
hostname:
{
Description: Container registry host name ,
Required: False ,
}
string ,
repository:
{
Description: Repository name ,
Required: False ,
}
string ,
tag:
{
Description: Image tag ,
Required: False ,
}
string ,
}
,
vulnerabilityFindings:
{
Description: Vulnerability findings details ,
Required: False ,
}
{
assetId:
{
Description: AssetId (Image digest). ,
Required: False ,
}
string ,
criticalFindingsCount:
{
Description: Number of critical findings. ,
Format: int32 ,
Required: False ,
}
integer ,
data:
{
Description: List of vulnerability findings. ,
Required: False ,
}
[
{
cve:
{
Description: CVE id. ,
Required: False ,
}
string ,
cveUrl:
{
Description: CVE url. ,
Required: False ,
}
string ,
dueDate:
{
Description: DueDate for vulnerability. Provider data or PublishDate + 30 days. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Vulnerability ID. ,
Required: False ,
}
string ,
packageDetails:
{
Description: Dependency details. ,
Required: False ,
}
[
{
installPath:
{
Description: Install path. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Installed version. ,
Required: False ,
}
string ,
name:
{
Description: Package or dependency name. ,
Required: False ,
}
string ,
patchedVersion:
{
Description: Patched version. ,
Required: False ,
}
string ,
}
,
]
,
patchable:
{
Description: Indicates if there is a known patch for vulnerability. ,
Required: False ,
}
boolean ,
providerId:
{
Description: Vulnerability ID from provider. ,
Required: False ,
}
string ,
publishDate:
{
Description: Vulnerability publish date. ,
Format: date-time ,
Required: False ,
}
string ,
risk:
{
Description: Vulnerability Risk value. ,
Enum:
{
UNKNOWN: No description available. ,
CRITICAL: No description available. ,
HIGH: No description available. ,
MEDIUM: No description available. ,
LOW: No description available. ,
}
,
Required: False ,
}
enum ,
solution:
{
Description: Vulnerability description. ,
Required: False ,
}
string ,
title:
{
Description: Vulnerability name. ,
Required: False ,
}
string ,
vendorId:
{
Description: Vendor vulnerability ID (USN, GH Advisory, etc). ,
Required: False ,
}
string ,
vendorUrl:
{
Description: Vendor vulnerability url. ,
Required: False ,
}
string ,
}
,
]
,
generatedTime:
{
Description: Time the report was generated. ,
Format: date-time ,
Required: False ,
}
string ,
highFindingsCount:
{
Description: Number of high findings. ,
Format: int32 ,
Required: False ,
}
integer ,
lastScanDate:
{
Description: Scan result date. ,
Format: date-time ,
Required: False ,
}
string ,
scanner:
{
Description: Vulnerability scanner name. ,
Required: False ,
}
string ,
source:
{
Description: Data source (internal). ,
Required: False ,
}
string ,
totalFindingsCount:
{
Description: Total findings count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
}
,
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 ,
}
,
]
,
}
,
}
RegistryModelContainers_List (new)
Description :  List model containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$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 ModelContainer objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type ModelContainer. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the model container. ,
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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryModelContainers_Delete (new)
Description :  Delete container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}
{
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 ,
modelName:
{
Description: Container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryModelContainers_Get (new)
Description :  Get container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}
{
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 ,
modelName:
{
Description: Container name. 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 ,
}
{
provisioningState:
{
Description: Provisioning state for the model container. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryModelContainers_CreateOrUpdate (new)
Description :  Create or update model container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}
{
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 ,
modelName:
{
Description: Container name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Container entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the model container. ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the model container. ,
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 ,
}
,
}

⚐ 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 ,
}
{
provisioningState:
{
Description: Provisioning state for the model container. ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryModelVersions_List (new)
Description :  List versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/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 ,
modelName:
{
Description: Container name. This is case-sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
$orderBy:
{
Description: Ordering of list. ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
version:
{
Description: Version identifier. ,
Required: False ,
}
string ,
description:
{
Description: Model description. ,
Required: False ,
}
string ,
tags:
{
Description: Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2 ,
Required: False ,
}
string ,
properties:
{
Description: Comma-separated list of property names (and optionally values). Example: prop1,prop2=value2 ,
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 ModelVersion objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type ModelVersion. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
flavors:
{
Description: Mapping of model flavors to their properties. ,
Required: False ,
}
object ,
jobName:
{
Description: Name of the training job which produced this model ,
Required: False ,
}
string ,
modelType:
{
Description: The storage format for this entity. Used for NCD. ,
Required: False ,
}
string ,
modelUri:
{
Description: The URI path to the model contents. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the model 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 model lifecycle assigned to this model ,
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 ,
}
,
]
,
}
,
}
RegistryModelVersions_Delete (new)
Description :  Delete version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/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 ,
modelName:
{
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 ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
RegistryModelVersions_Get (new)
Description :  Get version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/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 ,
modelName:
{
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 ,
}
{
flavors:
{
Description: Mapping of model flavors to their properties. ,
Required: False ,
}
object ,
jobName:
{
Description: Name of the training job which produced this model ,
Required: False ,
}
string ,
modelType:
{
Description: The storage format for this entity. Used for NCD. ,
Required: False ,
}
string ,
modelUri:
{
Description: The URI path to the model contents. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the model 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 model lifecycle assigned to this model ,
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 ,
}
,
]
,
}
,
}
RegistryModelVersions_CreateOrUpdate (new)
Description :  Create or update version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/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 ,
modelName:
{
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 ,
}
{
flavors:
{
Description: Mapping of model flavors to their properties. ,
Required: False ,
}
object ,
jobName:
{
Description: Name of the training job which produced this model ,
Required: False ,
}
string ,
modelType:
{
Description: The storage format for this entity. Used for NCD. ,
Required: False ,
}
string ,
modelUri:
{
Description: The URI path to the model contents. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the model 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 model lifecycle assigned to this model ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
flavors:
{
Description: Mapping of model flavors to their properties. ,
Required: False ,
}
object ,
jobName:
{
Description: Name of the training job which produced this model ,
Required: False ,
}
string ,
modelType:
{
Description: The storage format for this entity. Used for NCD. ,
Required: False ,
}
string ,
modelUri:
{
Description: The URI path to the model contents. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the model 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 model lifecycle assigned to this model ,
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 ,
}
{
flavors:
{
Description: Mapping of model flavors to their properties. ,
Required: False ,
}
object ,
jobName:
{
Description: Name of the training job which produced this model ,
Required: False ,
}
string ,
modelType:
{
Description: The storage format for this entity. Used for NCD. ,
Required: False ,
}
string ,
modelUri:
{
Description: The URI path to the model contents. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the model 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 model lifecycle assigned to this model ,
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 ,
}
,
]
,
}
,
}
RegistryModelVersions_CreateOrGetStartPendingUpload (new)
Description :  Generate a storage location and credential for the client to upload a model asset to.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}/startPendingUpload
{
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 ,
modelName:
{
Description: Model 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 ,
body:
{
Description: Pending upload request object ,
Required: True ,
}
{
pendingUploadId:
{
Description: If PendingUploadId = null then random guid will be used. ,
Required: False ,
}
string ,
pendingUploadType:
{
Description: TemporaryBlobReference is the only supported type ,
Enum:
{
None: No description available. ,
TemporaryBlobReference: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
blobReferenceForConsumption:
{
Description: Container level read, write, list SAS ,
Required: False ,
}
{
blobUri:
{
Description: Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path ,
Format: uri ,
Required: False ,
}
string ,
credential:
{
Description: Credential info to access storage account ,
Required: False ,
}
{
credentialType:
{
Description: [Required] Credential type used to authentication with storage. ,
Enum:
{
SAS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
storageAccountArmId:
{
Description: Arm ID of the storage account to use ,
Required: False ,
}
string ,
}
,
pendingUploadId:
{
Description: ID for this upload request ,
Required: False ,
}
string ,
pendingUploadType:
{
Description: TemporaryBlobReference is the only supported type ,
Enum:
{
None: No description available. ,
TemporaryBlobReference: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ 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 ,
}
,
]
,
}
,
}
BatchEndpoints_List (new)
Description :  Lists Batch inference endpoint in the workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
count:
{
Description: Number of endpoints to be retrieved in a page of results. ,
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 BatchEndpoint objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type BatchEndpoint. ,
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 ,
}
{
defaults:
{
Description: Default values for Batch Endpoint ,
Required: False ,
}
{
deploymentName:
{
Description: Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
BatchEndpoints_Delete (new)
Description :  Delete Batch Inference Endpoint (asynchronous).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}
{
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 ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
BatchEndpoints_Get (new)
Description :  Gets a batch inference endpoint by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}
{
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: Name for the Batch Endpoint. ,
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 ,
}
{
defaults:
{
Description: Default values for Batch Endpoint ,
Required: False ,
}
{
deploymentName:
{
Description: Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
BatchEndpoints_Update (new)
Description :  Update a batch inference endpoint (asynchronous).
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}
{
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: Name for the Batch inference endpoint. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Mutable batch inference endpoint definition object. ,
Required: True ,
}
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
type:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
,
}

⚐ 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 ,
}
{
defaults:
{
Description: Default values for Batch Endpoint ,
Required: False ,
}
{
deploymentName:
{
Description: Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
BatchEndpoints_CreateOrUpdate (new)
Description :  Creates a batch inference endpoint (asynchronous).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}
{
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: Name for the Batch inference endpoint. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Batch inference endpoint definition object. ,
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 ,
}
{
defaults:
{
Description: Default values for Batch Endpoint ,
Required: False ,
}
{
deploymentName:
{
Description: Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
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 ,
}
{
defaults:
{
Description: Default values for Batch Endpoint ,
Required: False ,
}
{
deploymentName:
{
Description: Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
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 ,
}
{
defaults:
{
Description: Default values for Batch Endpoint ,
Required: False ,
}
{
deploymentName:
{
Description: Name of the deployment that will be default for the endpoint. This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
BatchDeployments_List (new)
Description :  Lists Batch inference deployments in the workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{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: 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 BatchDeployment objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type BatchDeployment. ,
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 ,
}
{
compute:
{
Description: Compute target for batch inference operation. ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Description: Properties relevant to different deployment types. ,
Required: False ,
}
{
deploymentConfigurationType:
{
Description: [Required] The type of the deployment ,
Enum:
{
Model: No description available. ,
PipelineComponent: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
errorThreshold:
{
Description: Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored. ,
Format: int32 ,
Required: False ,
}
integer ,
loggingLevel:
{
Description: Logging level for batch inference operation. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Debug: No description available. ,
}
,
Required: False ,
}
enum ,
maxConcurrencyPerInstance:
{
Description: Indicates maximum number of parallelism per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
miniBatchSize:
{
Description: Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch. ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Reference to the model asset for the endpoint deployment. ,
Required: False ,
}
{
referenceType:
{
Description: [Required] Specifies the type of asset reference. ,
Enum:
{
Id: No description available. ,
DataPath: No description available. ,
OutputPath: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
outputAction:
{
Description: Indicates how the output will be organized. ,
Enum:
{
SummaryOnly: No description available. ,
AppendRow: No description available. ,
}
,
Required: False ,
}
enum ,
outputFileName:
{
Description: Customized output file name for append_row output action. ,
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 ,
resources:
{
Description: Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration. ,
Required: False ,
}
object ,
retrySettings:
{
Description: Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings. ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum retry count for a mini-batch ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: Invocation timeout for a mini-batch, in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
}
,
}
BatchDeployments_Delete (new)
Description :  Delete Batch Inference deployment (asynchronous).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{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: Endpoint name ,
Required: True ,
}
string ,
deploymentName:
{
Description: Inference deployment identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
BatchDeployments_Get (new)
Description :  Gets a batch inference deployment by id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{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: Endpoint name ,
Required: True ,
}
string ,
deploymentName:
{
Description: The identifier for the Batch deployments. ,
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 ,
}
{
compute:
{
Description: Compute target for batch inference operation. ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Description: Properties relevant to different deployment types. ,
Required: False ,
}
{
deploymentConfigurationType:
{
Description: [Required] The type of the deployment ,
Enum:
{
Model: No description available. ,
PipelineComponent: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
errorThreshold:
{
Description: Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored. ,
Format: int32 ,
Required: False ,
}
integer ,
loggingLevel:
{
Description: Logging level for batch inference operation. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Debug: No description available. ,
}
,
Required: False ,
}
enum ,
maxConcurrencyPerInstance:
{
Description: Indicates maximum number of parallelism per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
miniBatchSize:
{
Description: Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch. ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Reference to the model asset for the endpoint deployment. ,
Required: False ,
}
{
referenceType:
{
Description: [Required] Specifies the type of asset reference. ,
Enum:
{
Id: No description available. ,
DataPath: No description available. ,
OutputPath: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
outputAction:
{
Description: Indicates how the output will be organized. ,
Enum:
{
SummaryOnly: No description available. ,
AppendRow: No description available. ,
}
,
Required: False ,
}
enum ,
outputFileName:
{
Description: Customized output file name for append_row output action. ,
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 ,
resources:
{
Description: Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration. ,
Required: False ,
}
object ,
retrySettings:
{
Description: Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings. ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum retry count for a mini-batch ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: Invocation timeout for a mini-batch, in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
}
,
}
BatchDeployments_Update (new)
Description :  Update a batch inference deployment (asynchronous).
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{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: The identifier for the Batch inference deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Batch inference deployment definition object. ,
Required: True ,
}
{
properties:
{
Description: Additional attributes of the entity. ,
Required: False ,
}
{
description:
{
Description: Description of the endpoint deployment. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
{
compute:
{
Description: Compute target for batch inference operation. ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Description: Properties relevant to different deployment types. ,
Required: False ,
}
{
deploymentConfigurationType:
{
Description: [Required] The type of the deployment ,
Enum:
{
Model: No description available. ,
PipelineComponent: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
errorThreshold:
{
Description: Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored. ,
Format: int32 ,
Required: False ,
}
integer ,
loggingLevel:
{
Description: Logging level for batch inference operation. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Debug: No description available. ,
}
,
Required: False ,
}
enum ,
maxConcurrencyPerInstance:
{
Description: Indicates maximum number of parallelism per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
miniBatchSize:
{
Description: Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch. ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Reference to the model asset for the endpoint deployment. ,
Required: False ,
}
{
referenceType:
{
Description: [Required] Specifies the type of asset reference. ,
Enum:
{
Id: No description available. ,
DataPath: No description available. ,
OutputPath: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
outputAction:
{
Description: Indicates how the output will be organized. ,
Enum:
{
SummaryOnly: No description available. ,
AppendRow: No description available. ,
}
,
Required: False ,
}
enum ,
outputFileName:
{
Description: Customized output file name for append_row output action. ,
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 ,
resources:
{
Description: Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration. ,
Required: False ,
}
object ,
retrySettings:
{
Description: Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings. ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum retry count for a mini-batch ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: Invocation timeout for a mini-batch, in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
}
,
}
BatchDeployments_CreateOrUpdate (new)
Description :  Creates/updates a batch inference deployment (asynchronous).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{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: The identifier for the Batch inference deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Batch inference deployment definition object. ,
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 ,
}
{
compute:
{
Description: Compute target for batch inference operation. ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Description: Properties relevant to different deployment types. ,
Required: False ,
}
{
deploymentConfigurationType:
{
Description: [Required] The type of the deployment ,
Enum:
{
Model: No description available. ,
PipelineComponent: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
errorThreshold:
{
Description: Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored. ,
Format: int32 ,
Required: False ,
}
integer ,
loggingLevel:
{
Description: Logging level for batch inference operation. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Debug: No description available. ,
}
,
Required: False ,
}
enum ,
maxConcurrencyPerInstance:
{
Description: Indicates maximum number of parallelism per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
miniBatchSize:
{
Description: Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch. ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Reference to the model asset for the endpoint deployment. ,
Required: False ,
}
{
referenceType:
{
Description: [Required] Specifies the type of asset reference. ,
Enum:
{
Id: No description available. ,
DataPath: No description available. ,
OutputPath: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
outputAction:
{
Description: Indicates how the output will be organized. ,
Enum:
{
SummaryOnly: No description available. ,
AppendRow: No description available. ,
}
,
Required: False ,
}
enum ,
outputFileName:
{
Description: Customized output file name for append_row output action. ,
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 ,
resources:
{
Description: Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration. ,
Required: False ,
}
object ,
retrySettings:
{
Description: Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings. ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum retry count for a mini-batch ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: Invocation timeout for a mini-batch, in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
{
compute:
{
Description: Compute target for batch inference operation. ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Description: Properties relevant to different deployment types. ,
Required: False ,
}
{
deploymentConfigurationType:
{
Description: [Required] The type of the deployment ,
Enum:
{
Model: No description available. ,
PipelineComponent: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
errorThreshold:
{
Description: Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored. ,
Format: int32 ,
Required: False ,
}
integer ,
loggingLevel:
{
Description: Logging level for batch inference operation. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Debug: No description available. ,
}
,
Required: False ,
}
enum ,
maxConcurrencyPerInstance:
{
Description: Indicates maximum number of parallelism per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
miniBatchSize:
{
Description: Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch. ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Reference to the model asset for the endpoint deployment. ,
Required: False ,
}
{
referenceType:
{
Description: [Required] Specifies the type of asset reference. ,
Enum:
{
Id: No description available. ,
DataPath: No description available. ,
OutputPath: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
outputAction:
{
Description: Indicates how the output will be organized. ,
Enum:
{
SummaryOnly: No description available. ,
AppendRow: No description available. ,
}
,
Required: False ,
}
enum ,
outputFileName:
{
Description: Customized output file name for append_row output action. ,
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 ,
resources:
{
Description: Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration. ,
Required: False ,
}
object ,
retrySettings:
{
Description: Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings. ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum retry count for a mini-batch ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: Invocation timeout for a mini-batch, in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
{
compute:
{
Description: Compute target for batch inference operation. ,
Required: False ,
}
string ,
deploymentConfiguration:
{
Description: Properties relevant to different deployment types. ,
Required: False ,
}
{
deploymentConfigurationType:
{
Description: [Required] The type of the deployment ,
Enum:
{
Model: No description available. ,
PipelineComponent: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
errorThreshold:
{
Description: Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored. ,
Format: int32 ,
Required: False ,
}
integer ,
loggingLevel:
{
Description: Logging level for batch inference operation. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Debug: No description available. ,
}
,
Required: False ,
}
enum ,
maxConcurrencyPerInstance:
{
Description: Indicates maximum number of parallelism per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
miniBatchSize:
{
Description: Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch. ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Reference to the model asset for the endpoint deployment. ,
Required: False ,
}
{
referenceType:
{
Description: [Required] Specifies the type of asset reference. ,
Enum:
{
Id: No description available. ,
DataPath: No description available. ,
OutputPath: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
outputAction:
{
Description: Indicates how the output will be organized. ,
Enum:
{
SummaryOnly: No description available. ,
AppendRow: No description available. ,
}
,
Required: False ,
}
enum ,
outputFileName:
{
Description: Customized output file name for append_row output action. ,
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 ,
resources:
{
Description: Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration. ,
Required: False ,
}
object ,
retrySettings:
{
Description: Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings. ,
Required: False ,
}
{
maxRetries:
{
Description: Maximum retry count for a mini-batch ,
Format: int32 ,
Required: False ,
}
integer ,
timeout:
{
Description: Invocation timeout for a mini-batch, in ISO 8601 format. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
}
,
}
BatchEndpoints_ListKeys (new)
Description :  Lists batch Inference Endpoint keys.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys
{
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 ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
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 ,
}
,
]
,
}
,
}
CapabilityHosts_Delete (new)
Description :  Delete capabilityHost.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/capabilityHosts/{name}
{
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: CapabilityHost name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
CapabilityHosts_Get (new)
Description :  Get capabilityHost.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/capabilityHosts/{name}
{
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: CapabilityHost name. ,
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 ,
}
{
aiServicesConnections:
{
Description: List of AI services connections. ,
Required: False ,
}
[
string ,
]
,
capabilityHostKind:
{
Description: Kind of this capability host. ,
Enum:
{
Agents: No description available. ,
}
,
Required: False ,
}
enum ,
customerSubnet:
{
Description: Customer subnet info to help set up this capability host. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the CapabilityHost. ,
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 ,
storageConnections:
{
Description: List of Storage connections. ,
Required: False ,
}
[
string ,
]
,
threadStorageConnections:
{
Description: List of Thread storage connections. ,
Required: False ,
}
[
string ,
]
,
vectorStoreConnections:
{
Description: List of VectorStore connections. ,
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 ,
}
,
]
,
}
,
}
CapabilityHosts_CreateOrUpdate (new)
Description :  Create or update capabilityHost.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/capabilityHosts/{name}
{
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: CapabilityHost name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: CapabilityHost definition. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
aiServicesConnections:
{
Description: List of AI services connections. ,
Required: False ,
}
[
string ,
]
,
capabilityHostKind:
{
Description: Kind of this capability host. ,
Enum:
{
Agents: No description available. ,
}
,
Required: False ,
}
enum ,
customerSubnet:
{
Description: Customer subnet info to help set up this capability host. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the CapabilityHost. ,
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 ,
storageConnections:
{
Description: List of Storage connections. ,
Required: False ,
}
[
string ,
]
,
threadStorageConnections:
{
Description: List of Thread storage connections. ,
Required: False ,
}
[
string ,
]
,
vectorStoreConnections:
{
Description: List of VectorStore connections. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
aiServicesConnections:
{
Description: List of AI services connections. ,
Required: False ,
}
[
string ,
]
,
capabilityHostKind:
{
Description: Kind of this capability host. ,
Enum:
{
Agents: No description available. ,
}
,
Required: False ,
}
enum ,
customerSubnet:
{
Description: Customer subnet info to help set up this capability host. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the CapabilityHost. ,
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 ,
storageConnections:
{
Description: List of Storage connections. ,
Required: False ,
}
[
string ,
]
,
threadStorageConnections:
{
Description: List of Thread storage connections. ,
Required: False ,
}
[
string ,
]
,
vectorStoreConnections:
{
Description: List of VectorStore connections. ,
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 ,
}
{
aiServicesConnections:
{
Description: List of AI services connections. ,
Required: False ,
}
[
string ,
]
,
capabilityHostKind:
{
Description: Kind of this capability host. ,
Enum:
{
Agents: No description available. ,
}
,
Required: False ,
}
enum ,
customerSubnet:
{
Description: Customer subnet info to help set up this capability host. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the CapabilityHost. ,
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 ,
storageConnections:
{
Description: List of Storage connections. ,
Required: False ,
}
[
string ,
]
,
threadStorageConnections:
{
Description: List of Thread storage connections. ,
Required: False ,
}
[
string ,
]
,
vectorStoreConnections:
{
Description: List of VectorStore connections. ,
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 ,
}
,
]
,
}
,
}
CodeContainers_List (new)
Description :  List containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of CodeContainer objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type CodeContainer. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the code container. ,
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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CodeContainers_Delete (new)
Description :  Delete container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}
{
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 ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
CodeContainers_Get (new)
Description :  Get container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the code container. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CodeContainers_CreateOrUpdate (new)
Description :  Create or update container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}
{
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 ,
body:
{
Description: Container entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the code container. ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the code container. ,
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the code container. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CodeVersions_List (new)
Description :  List versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{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 ,
hash:
{
Description: If specified, return CodeVersion assets with specified content hash value, regardless of name ,
Required: False ,
}
string ,
hashVersion:
{
Description: Hash algorithm version when listing by hash ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of CodeVersion objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type CodeVersion. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
codeUri:
{
Description: Uri where code is located ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the code 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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CodeVersions_Delete (new)
Description :  Delete version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{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)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
CodeVersions_Get (new)
Description :  Get version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{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 ,
}
{
codeUri:
{
Description: Uri where code is located ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the code 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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CodeVersions_CreateOrUpdate (new)
Description :  Create or update version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{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 ,
body:
{
Description: Version entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
codeUri:
{
Description: Uri where code is located ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the code 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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
codeUri:
{
Description: Uri where code is located ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the code 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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
codeUri:
{
Description: Uri where code is located ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the code 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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CodeVersions_Publish (new)
Description :  Publish version asset into registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/publish
{
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. ,
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: Destination registry info ,
Required: True ,
}
{
destinationName:
{
Description: Destination asset name ,
Required: False ,
}
string ,
destinationVersion:
{
Description: Destination asset version ,
Required: False ,
}
string ,
registryName:
{
Description: Destination registry name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
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 ,
}
,
]
,
}
,
}
CodeVersions_CreateOrGetStartPendingUpload (new)
Description :  Generate a storage location and credential for the client to upload a code asset to.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/codes/{name}/versions/{version}/startPendingUpload
{
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 ,
body:
{
Description: Pending upload request object ,
Required: True ,
}
{
pendingUploadId:
{
Description: If PendingUploadId = null then random guid will be used. ,
Required: False ,
}
string ,
pendingUploadType:
{
Description: TemporaryBlobReference is the only supported type ,
Enum:
{
None: No description available. ,
TemporaryBlobReference: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
blobReferenceForConsumption:
{
Description: Container level read, write, list SAS ,
Required: False ,
}
{
blobUri:
{
Description: Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path ,
Format: uri ,
Required: False ,
}
string ,
credential:
{
Description: Credential info to access storage account ,
Required: False ,
}
{
credentialType:
{
Description: [Required] Credential type used to authentication with storage. ,
Enum:
{
SAS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
storageAccountArmId:
{
Description: Arm ID of the storage account to use ,
Required: False ,
}
string ,
}
,
pendingUploadId:
{
Description: ID for this upload request ,
Required: False ,
}
string ,
pendingUploadType:
{
Description: TemporaryBlobReference is the only supported type ,
Enum:
{
None: No description available. ,
TemporaryBlobReference: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ 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 ,
}
,
]
,
}
,
}
ComponentContainers_List (new)
Description :  List component containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$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 ComponentContainer objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type ComponentContainer. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the component container. ,
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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ComponentContainers_Delete (new)
Description :  Delete container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}
{
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ComponentContainers_Get (new)
Description :  Get container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}
{
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. ,
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 ,
}
{
provisioningState:
{
Description: Provisioning state for the component container. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ComponentContainers_CreateOrUpdate (new)
Description :  Create or update container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}
{
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Container entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the component container. ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the component container. ,
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the component container. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ComponentVersions_List (new)
Description :  List component versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{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: Component 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: 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 ComponentVersion objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type ComponentVersion. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
componentSpec:
{
Description: Defines Component definition details. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state for the component 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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ComponentVersions_Delete (new)
Description :  Delete version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{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. ,
Required: True ,
}
string ,
version:
{
Description: Version identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ComponentVersions_Get (new)
Description :  Get version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{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. ,
Required: True ,
}
string ,
version:
{
Description: Version identifier. ,
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 ,
}
{
componentSpec:
{
Description: Defines Component definition details. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state for the component 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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ComponentVersions_CreateOrUpdate (new)
Description :  Create or update version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{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. ,
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 ,
}
{
componentSpec:
{
Description: Defines Component definition details. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state for the component 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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
componentSpec:
{
Description: Defines Component definition details. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state for the component 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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
componentSpec:
{
Description: Defines Component definition details. ,
Required: False ,
}
object ,
provisioningState:
{
Description: Provisioning state for the component 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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ComponentVersions_Publish (new)
Description :  Publish version asset into registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/components/{name}/versions/{version}/publish
{
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. ,
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: Destination registry info ,
Required: True ,
}
{
destinationName:
{
Description: Destination asset name ,
Required: False ,
}
string ,
destinationVersion:
{
Description: Destination asset version ,
Required: False ,
}
string ,
registryName:
{
Description: Destination registry name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
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 ,
}
,
]
,
}
,
}
DataContainers_List (new)
Description :  List data containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$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 DataContainer objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type DataContainer. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DataContainers_Delete (new)
Description :  Delete container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}
{
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
DataContainers_Get (new)
Description :  Get container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}
{
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. ,
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 ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DataContainers_CreateOrUpdate (new)
Description :  Create or update container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}
{
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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Container entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DataVersions_List (new)
Description :  List data versions in the data container
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{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: Data container's name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$orderBy:
{
Description: Please choose OrderBy value from ['createdtime', 'modifiedtime'] ,
Required: False ,
}
string ,
$top:
{
Description: Top count of results, top count cannot be greater than the page size. If topCount > page size, results with be default page size count will be returned ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
$tags:
{
Description: Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2 ,
Required: False ,
}
string ,
listViewType:
{
Description: [ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of DataVersionBase objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type DataVersionBase. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
dataUri:
{
Description: [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
DataVersions_Delete (new)
Description :  Delete version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{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. ,
Required: True ,
}
string ,
version:
{
Description: Version identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
DataVersions_Get (new)
Description :  Get version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{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. ,
Required: True ,
}
string ,
version:
{
Description: Version identifier. ,
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 ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
dataUri:
{
Description: [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
DataVersions_CreateOrUpdate (new)
Description :  Create or update version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{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. ,
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 ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
dataUri:
{
Description: [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
dataUri:
{
Description: [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: [Required] Specifies the type of data. ,
Enum:
{
uri_file: No description available. ,
uri_folder: No description available. ,
mltable: No description available. ,
}
,
Required: True ,
}
enum ,
dataUri:
{
Description: [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
DataVersions_Publish (new)
Description :  Publish version asset into registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/data/{name}/versions/{version}/publish
{
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. ,
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: Destination registry info ,
Required: True ,
}
{
destinationName:
{
Description: Destination asset name ,
Required: False ,
}
string ,
destinationVersion:
{
Description: Destination asset version ,
Required: False ,
}
string ,
registryName:
{
Description: Destination registry name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
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 ,
}
,
]
,
}
,
}
Datastores_List (new)
Description :  List datastores.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
count:
{
Description: Maximum number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
isDefault:
{
Description: Filter down to the workspace default datastore. ,
Required: False ,
}
boolean ,
names:
{
Description: Names of datastores to return. ,
Required: False ,
}
array ,
searchText:
{
Description: Text to search for in the datastore names. ,
Required: False ,
}
string ,
orderBy:
{
Description: Order by property (createdtime | modifiedtime | name). ,
Required: False ,
}
string ,
orderByAsc:
{
Description: Order by property in ascending order. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of Datastore objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type Datastore. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
credentials:
{
Description: [Required] Account credentials. ,
Required: True ,
}
{
credentialsType:
{
Description: [Required] Credential type used to authentication with storage. ,
Enum:
{
AccountKey: No description available. ,
Certificate: No description available. ,
None: No description available. ,
Sas: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
datastoreType:
{
Description: [Required] Storage type backing the datastore. ,
Enum:
{
AzureBlob: No description available. ,
AzureDataLakeGen1: No description available. ,
AzureDataLakeGen2: No description available. ,
AzureFile: No description available. ,
OneLake: No description available. ,
}
,
Required: True ,
}
enum ,
isDefault:
{
Description: Readonly property to indicate if datastore is the workspace default datastore ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Datastores_Delete (new)
Description :  Delete datastore.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}
{
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: Datastore name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Datastores_Get (new)
Description :  Get datastore.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}
{
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: Datastore name. ,
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 ,
}
{
credentials:
{
Description: [Required] Account credentials. ,
Required: True ,
}
{
credentialsType:
{
Description: [Required] Credential type used to authentication with storage. ,
Enum:
{
AccountKey: No description available. ,
Certificate: No description available. ,
None: No description available. ,
Sas: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
datastoreType:
{
Description: [Required] Storage type backing the datastore. ,
Enum:
{
AzureBlob: No description available. ,
AzureDataLakeGen1: No description available. ,
AzureDataLakeGen2: No description available. ,
AzureFile: No description available. ,
OneLake: No description available. ,
}
,
Required: True ,
}
enum ,
isDefault:
{
Description: Readonly property to indicate if datastore is the workspace default datastore ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Datastores_CreateOrUpdate (new)
Description :  Create or update datastore.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}
{
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: Datastore name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
skipValidation:
{
Description: Flag to skip validation. ,
Required: False ,
}
boolean ,
body:
{
Description: Datastore entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
credentials:
{
Description: [Required] Account credentials. ,
Required: True ,
}
{
credentialsType:
{
Description: [Required] Credential type used to authentication with storage. ,
Enum:
{
AccountKey: No description available. ,
Certificate: No description available. ,
None: No description available. ,
Sas: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
datastoreType:
{
Description: [Required] Storage type backing the datastore. ,
Enum:
{
AzureBlob: No description available. ,
AzureDataLakeGen1: No description available. ,
AzureDataLakeGen2: No description available. ,
AzureFile: No description available. ,
OneLake: No description available. ,
}
,
Required: True ,
}
enum ,
isDefault:
{
Description: Readonly property to indicate if datastore is the workspace default datastore ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
credentials:
{
Description: [Required] Account credentials. ,
Required: True ,
}
{
credentialsType:
{
Description: [Required] Credential type used to authentication with storage. ,
Enum:
{
AccountKey: No description available. ,
Certificate: No description available. ,
None: No description available. ,
Sas: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
datastoreType:
{
Description: [Required] Storage type backing the datastore. ,
Enum:
{
AzureBlob: No description available. ,
AzureDataLakeGen1: No description available. ,
AzureDataLakeGen2: No description available. ,
AzureFile: No description available. ,
OneLake: No description available. ,
}
,
Required: True ,
}
enum ,
isDefault:
{
Description: Readonly property to indicate if datastore is the workspace default datastore ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
credentials:
{
Description: [Required] Account credentials. ,
Required: True ,
}
{
credentialsType:
{
Description: [Required] Credential type used to authentication with storage. ,
Enum:
{
AccountKey: No description available. ,
Certificate: No description available. ,
None: No description available. ,
Sas: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
datastoreType:
{
Description: [Required] Storage type backing the datastore. ,
Enum:
{
AzureBlob: No description available. ,
AzureDataLakeGen1: No description available. ,
AzureDataLakeGen2: No description available. ,
AzureFile: No description available. ,
OneLake: No description available. ,
}
,
Required: True ,
}
enum ,
isDefault:
{
Description: Readonly property to indicate if datastore is the workspace default datastore ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Datastores_ListSecrets (new)
Description :  Get datastore secrets.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{name}/listSecrets
{
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: Datastore name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Secret expiry information. ,
Required: False ,
}
{
expirableSecret:
{
Description: Indicates if the secret is expirable. ,
Required: False ,
}
boolean ,
expireAfterHours:
{
Description: Number of hours after which the secret will expire. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
secretsType:
{
Description: [Required] Credential type used to authentication with storage. ,
Enum:
{
AccountKey: No description available. ,
Certificate: No description available. ,
Sas: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ 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 ,
}
,
]
,
}
,
}
EnvironmentContainers_List (new)
Description :  List environment containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$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 EnvironmentContainer objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type EnvironmentContainer. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the environment container. ,
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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
EnvironmentContainers_Delete (new)
Description :  Delete container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}
{
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 ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
EnvironmentContainers_Get (new)
Description :  Get container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the environment container. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
EnvironmentContainers_CreateOrUpdate (new)
Description :  Create or update container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}
{
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 ,
body:
{
Description: Container entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the environment container. ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the environment container. ,
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the environment container. ,
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 ,
}
,
}

⚐ 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 (new)
Description :  List versions.
Reference :  Link ¶

⚼ 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 ,
imageDetails:
{
Description: Environment image details ,
Required: False ,
}
{
exists:
{
Description: Indicates if image exists ,
Required: False ,
}
boolean ,
image:
{
Description: Container image details ,
Required: False ,
}
{
digest:
{
Description: Image digest ,
Required: False ,
}
string ,
hostname:
{
Description: Container registry host name ,
Required: False ,
}
string ,
repository:
{
Description: Repository name ,
Required: False ,
}
string ,
tag:
{
Description: Image tag ,
Required: False ,
}
string ,
}
,
vulnerabilityFindings:
{
Description: Vulnerability findings details ,
Required: False ,
}
{
assetId:
{
Description: AssetId (Image digest). ,
Required: False ,
}
string ,
criticalFindingsCount:
{
Description: Number of critical findings. ,
Format: int32 ,
Required: False ,
}
integer ,
data:
{
Description: List of vulnerability findings. ,
Required: False ,
}
[
{
cve:
{
Description: CVE id. ,
Required: False ,
}
string ,
cveUrl:
{
Description: CVE url. ,
Required: False ,
}
string ,
dueDate:
{
Description: DueDate for vulnerability. Provider data or PublishDate + 30 days. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Vulnerability ID. ,
Required: False ,
}
string ,
packageDetails:
{
Description: Dependency details. ,
Required: False ,
}
[
{
installPath:
{
Description: Install path. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Installed version. ,
Required: False ,
}
string ,
name:
{
Description: Package or dependency name. ,
Required: False ,
}
string ,
patchedVersion:
{
Description: Patched version. ,
Required: False ,
}
string ,
}
,
]
,
patchable:
{
Description: Indicates if there is a known patch for vulnerability. ,
Required: False ,
}
boolean ,
providerId:
{
Description: Vulnerability ID from provider. ,
Required: False ,
}
string ,
publishDate:
{
Description: Vulnerability publish date. ,
Format: date-time ,
Required: False ,
}
string ,
risk:
{
Description: Vulnerability Risk value. ,
Enum:
{
UNKNOWN: No description available. ,
CRITICAL: No description available. ,
HIGH: No description available. ,
MEDIUM: No description available. ,
LOW: No description available. ,
}
,
Required: False ,
}
enum ,
solution:
{
Description: Vulnerability description. ,
Required: False ,
}
string ,
title:
{
Description: Vulnerability name. ,
Required: False ,
}
string ,
vendorId:
{
Description: Vendor vulnerability ID (USN, GH Advisory, etc). ,
Required: False ,
}
string ,
vendorUrl:
{
Description: Vendor vulnerability url. ,
Required: False ,
}
string ,
}
,
]
,
generatedTime:
{
Description: Time the report was generated. ,
Format: date-time ,
Required: False ,
}
string ,
highFindingsCount:
{
Description: Number of high findings. ,
Format: int32 ,
Required: False ,
}
integer ,
lastScanDate:
{
Description: Scan result date. ,
Format: date-time ,
Required: False ,
}
string ,
scanner:
{
Description: Vulnerability scanner name. ,
Required: False ,
}
string ,
source:
{
Description: Data source (internal). ,
Required: False ,
}
string ,
totalFindingsCount:
{
Description: Total findings count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
}
,
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_Delete (new)
Description :  Delete version.
Reference :  Link ¶

⚼ Request

DELETE:  /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)

{}

⚐ Response (204)

{}

⚐ 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 (new)
Description :  Get version.
Reference :  Link ¶

⚼ 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 ,
imageDetails:
{
Description: Environment image details ,
Required: False ,
}
{
exists:
{
Description: Indicates if image exists ,
Required: False ,
}
boolean ,
image:
{
Description: Container image details ,
Required: False ,
}
{
digest:
{
Description: Image digest ,
Required: False ,
}
string ,
hostname:
{
Description: Container registry host name ,
Required: False ,
}
string ,
repository:
{
Description: Repository name ,
Required: False ,
}
string ,
tag:
{
Description: Image tag ,
Required: False ,
}
string ,
}
,
vulnerabilityFindings:
{
Description: Vulnerability findings details ,
Required: False ,
}
{
assetId:
{
Description: AssetId (Image digest). ,
Required: False ,
}
string ,
criticalFindingsCount:
{
Description: Number of critical findings. ,
Format: int32 ,
Required: False ,
}
integer ,
data:
{
Description: List of vulnerability findings. ,
Required: False ,
}
[
{
cve:
{
Description: CVE id. ,
Required: False ,
}
string ,
cveUrl:
{
Description: CVE url. ,
Required: False ,
}
string ,
dueDate:
{
Description: DueDate for vulnerability. Provider data or PublishDate + 30 days. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Vulnerability ID. ,
Required: False ,
}
string ,
packageDetails:
{
Description: Dependency details. ,
Required: False ,
}
[
{
installPath:
{
Description: Install path. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Installed version. ,
Required: False ,
}
string ,
name:
{
Description: Package or dependency name. ,
Required: False ,
}
string ,
patchedVersion:
{
Description: Patched version. ,
Required: False ,
}
string ,
}
,
]
,
patchable:
{
Description: Indicates if there is a known patch for vulnerability. ,
Required: False ,
}
boolean ,
providerId:
{
Description: Vulnerability ID from provider. ,
Required: False ,
}
string ,
publishDate:
{
Description: Vulnerability publish date. ,
Format: date-time ,
Required: False ,
}
string ,
risk:
{
Description: Vulnerability Risk value. ,
Enum:
{
UNKNOWN: No description available. ,
CRITICAL: No description available. ,
HIGH: No description available. ,
MEDIUM: No description available. ,
LOW: No description available. ,
}
,
Required: False ,
}
enum ,
solution:
{
Description: Vulnerability description. ,
Required: False ,
}
string ,
title:
{
Description: Vulnerability name. ,
Required: False ,
}
string ,
vendorId:
{
Description: Vendor vulnerability ID (USN, GH Advisory, etc). ,
Required: False ,
}
string ,
vendorUrl:
{
Description: Vendor vulnerability url. ,
Required: False ,
}
string ,
}
,
]
,
generatedTime:
{
Description: Time the report was generated. ,
Format: date-time ,
Required: False ,
}
string ,
highFindingsCount:
{
Description: Number of high findings. ,
Format: int32 ,
Required: False ,
}
integer ,
lastScanDate:
{
Description: Scan result date. ,
Format: date-time ,
Required: False ,
}
string ,
scanner:
{
Description: Vulnerability scanner name. ,
Required: False ,
}
string ,
source:
{
Description: Data source (internal). ,
Required: False ,
}
string ,
totalFindingsCount:
{
Description: Total findings count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
}
,
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 (new)
Description :  Creates or updates an EnvironmentVersion.
Reference :  Link ¶

⚼ 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 ,
imageDetails:
{
Description: Environment image details ,
Required: False ,
}
{
exists:
{
Description: Indicates if image exists ,
Required: False ,
}
boolean ,
image:
{
Description: Container image details ,
Required: False ,
}
{
digest:
{
Description: Image digest ,
Required: False ,
}
string ,
hostname:
{
Description: Container registry host name ,
Required: False ,
}
string ,
repository:
{
Description: Repository name ,
Required: False ,
}
string ,
tag:
{
Description: Image tag ,
Required: False ,
}
string ,
}
,
vulnerabilityFindings:
{
Description: Vulnerability findings details ,
Required: False ,
}
{
assetId:
{
Description: AssetId (Image digest). ,
Required: False ,
}
string ,
criticalFindingsCount:
{
Description: Number of critical findings. ,
Format: int32 ,
Required: False ,
}
integer ,
data:
{
Description: List of vulnerability findings. ,
Required: False ,
}
[
{
cve:
{
Description: CVE id. ,
Required: False ,
}
string ,
cveUrl:
{
Description: CVE url. ,
Required: False ,
}
string ,
dueDate:
{
Description: DueDate for vulnerability. Provider data or PublishDate + 30 days. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Vulnerability ID. ,
Required: False ,
}
string ,
packageDetails:
{
Description: Dependency details. ,
Required: False ,
}
[
{
installPath:
{
Description: Install path. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Installed version. ,
Required: False ,
}
string ,
name:
{
Description: Package or dependency name. ,
Required: False ,
}
string ,
patchedVersion:
{
Description: Patched version. ,
Required: False ,
}
string ,
}
,
]
,
patchable:
{
Description: Indicates if there is a known patch for vulnerability. ,
Required: False ,
}
boolean ,
providerId:
{
Description: Vulnerability ID from provider. ,
Required: False ,
}
string ,
publishDate:
{
Description: Vulnerability publish date. ,
Format: date-time ,
Required: False ,
}
string ,
risk:
{
Description: Vulnerability Risk value. ,
Enum:
{
UNKNOWN: No description available. ,
CRITICAL: No description available. ,
HIGH: No description available. ,
MEDIUM: No description available. ,
LOW: No description available. ,
}
,
Required: False ,
}
enum ,
solution:
{
Description: Vulnerability description. ,
Required: False ,
}
string ,
title:
{
Description: Vulnerability name. ,
Required: False ,
}
string ,
vendorId:
{
Description: Vendor vulnerability ID (USN, GH Advisory, etc). ,
Required: False ,
}
string ,
vendorUrl:
{
Description: Vendor vulnerability url. ,
Required: False ,
}
string ,
}
,
]
,
generatedTime:
{
Description: Time the report was generated. ,
Format: date-time ,
Required: False ,
}
string ,
highFindingsCount:
{
Description: Number of high findings. ,
Format: int32 ,
Required: False ,
}
integer ,
lastScanDate:
{
Description: Scan result date. ,
Format: date-time ,
Required: False ,
}
string ,
scanner:
{
Description: Vulnerability scanner name. ,
Required: False ,
}
string ,
source:
{
Description: Data source (internal). ,
Required: False ,
}
string ,
totalFindingsCount:
{
Description: Total findings count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
}
,
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 ,
imageDetails:
{
Description: Environment image details ,
Required: False ,
}
{
exists:
{
Description: Indicates if image exists ,
Required: False ,
}
boolean ,
image:
{
Description: Container image details ,
Required: False ,
}
{
digest:
{
Description: Image digest ,
Required: False ,
}
string ,
hostname:
{
Description: Container registry host name ,
Required: False ,
}
string ,
repository:
{
Description: Repository name ,
Required: False ,
}
string ,
tag:
{
Description: Image tag ,
Required: False ,
}
string ,
}
,
vulnerabilityFindings:
{
Description: Vulnerability findings details ,
Required: False ,
}
{
assetId:
{
Description: AssetId (Image digest). ,
Required: False ,
}
string ,
criticalFindingsCount:
{
Description: Number of critical findings. ,
Format: int32 ,
Required: False ,
}
integer ,
data:
{
Description: List of vulnerability findings. ,
Required: False ,
}
[
{
cve:
{
Description: CVE id. ,
Required: False ,
}
string ,
cveUrl:
{
Description: CVE url. ,
Required: False ,
}
string ,
dueDate:
{
Description: DueDate for vulnerability. Provider data or PublishDate + 30 days. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Vulnerability ID. ,
Required: False ,
}
string ,
packageDetails:
{
Description: Dependency details. ,
Required: False ,
}
[
{
installPath:
{
Description: Install path. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Installed version. ,
Required: False ,
}
string ,
name:
{
Description: Package or dependency name. ,
Required: False ,
}
string ,
patchedVersion:
{
Description: Patched version. ,
Required: False ,
}
string ,
}
,
]
,
patchable:
{
Description: Indicates if there is a known patch for vulnerability. ,
Required: False ,
}
boolean ,
providerId:
{
Description: Vulnerability ID from provider. ,
Required: False ,
}
string ,
publishDate:
{
Description: Vulnerability publish date. ,
Format: date-time ,
Required: False ,
}
string ,
risk:
{
Description: Vulnerability Risk value. ,
Enum:
{
UNKNOWN: No description available. ,
CRITICAL: No description available. ,
HIGH: No description available. ,
MEDIUM: No description available. ,
LOW: No description available. ,
}
,
Required: False ,
}
enum ,
solution:
{
Description: Vulnerability description. ,
Required: False ,
}
string ,
title:
{
Description: Vulnerability name. ,
Required: False ,
}
string ,
vendorId:
{
Description: Vendor vulnerability ID (USN, GH Advisory, etc). ,
Required: False ,
}
string ,
vendorUrl:
{
Description: Vendor vulnerability url. ,
Required: False ,
}
string ,
}
,
]
,
generatedTime:
{
Description: Time the report was generated. ,
Format: date-time ,
Required: False ,
}
string ,
highFindingsCount:
{
Description: Number of high findings. ,
Format: int32 ,
Required: False ,
}
integer ,
lastScanDate:
{
Description: Scan result date. ,
Format: date-time ,
Required: False ,
}
string ,
scanner:
{
Description: Vulnerability scanner name. ,
Required: False ,
}
string ,
source:
{
Description: Data source (internal). ,
Required: False ,
}
string ,
totalFindingsCount:
{
Description: Total findings count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
}
,
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 ,
imageDetails:
{
Description: Environment image details ,
Required: False ,
}
{
exists:
{
Description: Indicates if image exists ,
Required: False ,
}
boolean ,
image:
{
Description: Container image details ,
Required: False ,
}
{
digest:
{
Description: Image digest ,
Required: False ,
}
string ,
hostname:
{
Description: Container registry host name ,
Required: False ,
}
string ,
repository:
{
Description: Repository name ,
Required: False ,
}
string ,
tag:
{
Description: Image tag ,
Required: False ,
}
string ,
}
,
vulnerabilityFindings:
{
Description: Vulnerability findings details ,
Required: False ,
}
{
assetId:
{
Description: AssetId (Image digest). ,
Required: False ,
}
string ,
criticalFindingsCount:
{
Description: Number of critical findings. ,
Format: int32 ,
Required: False ,
}
integer ,
data:
{
Description: List of vulnerability findings. ,
Required: False ,
}
[
{
cve:
{
Description: CVE id. ,
Required: False ,
}
string ,
cveUrl:
{
Description: CVE url. ,
Required: False ,
}
string ,
dueDate:
{
Description: DueDate for vulnerability. Provider data or PublishDate + 30 days. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Vulnerability ID. ,
Required: False ,
}
string ,
packageDetails:
{
Description: Dependency details. ,
Required: False ,
}
[
{
installPath:
{
Description: Install path. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Installed version. ,
Required: False ,
}
string ,
name:
{
Description: Package or dependency name. ,
Required: False ,
}
string ,
patchedVersion:
{
Description: Patched version. ,
Required: False ,
}
string ,
}
,
]
,
patchable:
{
Description: Indicates if there is a known patch for vulnerability. ,
Required: False ,
}
boolean ,
providerId:
{
Description: Vulnerability ID from provider. ,
Required: False ,
}
string ,
publishDate:
{
Description: Vulnerability publish date. ,
Format: date-time ,
Required: False ,
}
string ,
risk:
{
Description: Vulnerability Risk value. ,
Enum:
{
UNKNOWN: No description available. ,
CRITICAL: No description available. ,
HIGH: No description available. ,
MEDIUM: No description available. ,
LOW: No description available. ,
}
,
Required: False ,
}
enum ,
solution:
{
Description: Vulnerability description. ,
Required: False ,
}
string ,
title:
{
Description: Vulnerability name. ,
Required: False ,
}
string ,
vendorId:
{
Description: Vendor vulnerability ID (USN, GH Advisory, etc). ,
Required: False ,
}
string ,
vendorUrl:
{
Description: Vendor vulnerability url. ,
Required: False ,
}
string ,
}
,
]
,
generatedTime:
{
Description: Time the report was generated. ,
Format: date-time ,
Required: False ,
}
string ,
highFindingsCount:
{
Description: Number of high findings. ,
Format: int32 ,
Required: False ,
}
integer ,
lastScanDate:
{
Description: Scan result date. ,
Format: date-time ,
Required: False ,
}
string ,
scanner:
{
Description: Vulnerability scanner name. ,
Required: False ,
}
string ,
source:
{
Description: Data source (internal). ,
Required: False ,
}
string ,
totalFindingsCount:
{
Description: Total findings count. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
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 ,
}
,
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_Publish (new)
Description :  Publish version asset into registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/environments/{name}/versions/{version}/publish
{
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. ,
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: Destination registry info ,
Required: True ,
}
{
destinationName:
{
Description: Destination asset name ,
Required: False ,
}
string ,
destinationVersion:
{
Description: Destination asset version ,
Required: False ,
}
string ,
registryName:
{
Description: Destination registry name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
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 ,
}
,
]
,
}
,
}
FeaturesetContainers_List (new)
Description :  List featurestore entity containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
tags:
{
Description: Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2 ,
Required: False ,
}
string ,
listViewType:
{
Description: [ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities. ,
Required: False ,
}
string ,
pageSize:
{
Description: page size ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: name for the featureset ,
Required: False ,
}
string ,
description:
{
Description: description for the feature set ,
Required: False ,
}
string ,
createdBy:
{
Description: createdBy user name ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of FeaturesetContainer objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type FeaturesetContainer. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the featureset container. ,
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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Features_List (new)
Description :  List Features.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features
{
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 ,
featuresetName:
{
Description: Featureset name. This is case-sensitive. ,
Required: True ,
}
string ,
featuresetVersion:
{
Description: Featureset Version identifier. This is case-sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
tags:
{
Description: Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2 ,
Required: False ,
}
string ,
featureName:
{
Description: feature name. ,
Required: False ,
}
string ,
description:
{
Description: Description of the featureset. ,
Required: False ,
}
string ,
listViewType:
{
Description: [ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities. ,
Required: False ,
}
string ,
pageSize:
{
Description: Page size. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of Feature objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type Feature. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
dataType:
{
Description: Specifies type ,
Enum:
{
String: No description available. ,
Integer: No description available. ,
Long: No description available. ,
Float: No description available. ,
Double: No description available. ,
Binary: No description available. ,
Datetime: No description available. ,
Boolean: No description available. ,
}
,
Required: False ,
}
enum ,
featureName:
{
Description: Specifies name ,
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 ,
}
,
]
,
}
,
}
Features_Get (new)
Description :  Get feature.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{featuresetName}/versions/{featuresetVersion}/features/{featureName}
{
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 ,
featuresetName:
{
Description: Feature set name. This is case-sensitive. ,
Required: True ,
}
string ,
featuresetVersion:
{
Description: Feature set version identifier. This is case-sensitive. ,
Required: True ,
}
string ,
featureName:
{
Description: Feature Name. 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 ,
}
{
dataType:
{
Description: Specifies type ,
Enum:
{
String: No description available. ,
Integer: No description available. ,
Long: No description available. ,
Float: No description available. ,
Double: No description available. ,
Binary: No description available. ,
Datetime: No description available. ,
Boolean: No description available. ,
}
,
Required: False ,
}
enum ,
featureName:
{
Description: Specifies name ,
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 ,
}
,
]
,
}
,
}
FeaturesetContainers_Delete (new)
Description :  Delete container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}
{
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 ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
FeaturesetContainers_GetEntity (new)
Description :  Get container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the featureset container. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
FeaturesetContainers_CreateOrUpdate (new)
Description :  Create or update container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}
{
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 ,
body:
{
Description: Container entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the featureset container. ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the featureset container. ,
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 ,
}
,
}

⚐ 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 ,
}
{
provisioningState:
{
Description: Provisioning state for the featureset container. ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
FeaturesetVersions_List (new)
Description :  List versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{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: Featureset name. This is case-sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
tags:
{
Description: Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2 ,
Required: False ,
}
string ,
listViewType:
{
Description: [ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities. ,
Required: False ,
}
string ,
pageSize:
{
Description: page size ,
Format: int32 ,
Required: False ,
}
integer ,
versionName:
{
Description: name for the featureset version ,
Required: False ,
}
string ,
version:
{
Description: featureset version ,
Required: False ,
}
string ,
description:
{
Description: description for the feature set version ,
Required: False ,
}
string ,
createdBy:
{
Description: createdBy user name ,
Required: False ,
}
string ,
stage:
{
Description: Specifies the featurestore stage ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of FeaturesetVersion objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type FeaturesetVersion. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
entities:
{
Description: Specifies list of entities ,
Required: False ,
}
[
string ,
]
,
materializationSettings:
{
Description: Specifies the materialization settings ,
Required: False ,
}
{
notification:
{
Description: Specifies the notification details ,
Required: False ,
}
{
emailOn:
{
Description: Send email notification to user on specified notification type ,
Required: False ,
}
[
string ,
]
,
emails:
{
Description: This is the email recipient list which has a limitation of 499 characters in total concat with comma separator ,
Required: False ,
}
[
string ,
]
,
webhooks:
{
Description: Send webhook callback to a service. Key is a user-provided name for the webhook. ,
Required: False ,
}
object ,
}
,
resource:
{
Description: Specifies the compute resource settings ,
Required: False ,
}
{
instanceType:
{
Description: Specifies the instance type ,
Required: False ,
}
string ,
}
,
schedule:
{
Description: Specifies the schedule details ,
Required: False ,
}
{
frequency:
{
Description: [Required] The frequency to trigger schedule. ,
Enum:
{
Minute: Minute frequency ,
Hour: Hour frequency ,
Day: Day frequency ,
Week: Week frequency ,
Month: Month frequency ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: [Required] Specifies schedule interval in conjunction with frequency ,
Format: int32 ,
Required: True ,
}
integer ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
hours:
{
Description: [Required] List of hours for the schedule. ,
Required: True ,
}
[
integer ,
]
,
minutes:
{
Description: [Required] List of minutes for the schedule. ,
Required: True ,
}
[
integer ,
]
,
monthDays:
{
Description: List of month days for the schedule ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: List of days for the schedule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
sparkConfiguration:
{
Description: Specifies the spark compute settings ,
Required: False ,
}
object ,
storeType:
{
Description: Specifies the stores to which materialization should happen ,
Enum:
{
None: No description available. ,
Online: No description available. ,
Offline: No description available. ,
OnlineAndOffline: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state for the featureset version container. ,
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 ,
specification:
{
Description: Specifies the feature spec details ,
Required: False ,
}
{
path:
{
Description: Specifies the spec path ,
Required: False ,
}
string ,
}
,
stage:
{
Description: Specifies the asset stage ,
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 ,
}
,
]
,
}
,
}
FeaturesetVersions_Delete (new)
Description :  Delete version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{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)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
FeaturesetVersions_Get (new)
Description :  Get version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{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 ,
}
{
entities:
{
Description: Specifies list of entities ,
Required: False ,
}
[
string ,
]
,
materializationSettings:
{
Description: Specifies the materialization settings ,
Required: False ,
}
{
notification:
{
Description: Specifies the notification details ,
Required: False ,
}
{
emailOn:
{
Description: Send email notification to user on specified notification type ,
Required: False ,
}
[
string ,
]
,
emails:
{
Description: This is the email recipient list which has a limitation of 499 characters in total concat with comma separator ,
Required: False ,
}
[
string ,
]
,
webhooks:
{
Description: Send webhook callback to a service. Key is a user-provided name for the webhook. ,
Required: False ,
}
object ,
}
,
resource:
{
Description: Specifies the compute resource settings ,
Required: False ,
}
{
instanceType:
{
Description: Specifies the instance type ,
Required: False ,
}
string ,
}
,
schedule:
{
Description: Specifies the schedule details ,
Required: False ,
}
{
frequency:
{
Description: [Required] The frequency to trigger schedule. ,
Enum:
{
Minute: Minute frequency ,
Hour: Hour frequency ,
Day: Day frequency ,
Week: Week frequency ,
Month: Month frequency ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: [Required] Specifies schedule interval in conjunction with frequency ,
Format: int32 ,
Required: True ,
}
integer ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
hours:
{
Description: [Required] List of hours for the schedule. ,
Required: True ,
}
[
integer ,
]
,
minutes:
{
Description: [Required] List of minutes for the schedule. ,
Required: True ,
}
[
integer ,
]
,
monthDays:
{
Description: List of month days for the schedule ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: List of days for the schedule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
sparkConfiguration:
{
Description: Specifies the spark compute settings ,
Required: False ,
}
object ,
storeType:
{
Description: Specifies the stores to which materialization should happen ,
Enum:
{
None: No description available. ,
Online: No description available. ,
Offline: No description available. ,
OnlineAndOffline: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state for the featureset version container. ,
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 ,
specification:
{
Description: Specifies the feature spec details ,
Required: False ,
}
{
path:
{
Description: Specifies the spec path ,
Required: False ,
}
string ,
}
,
stage:
{
Description: Specifies the asset stage ,
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 ,
}
,
]
,
}
,
}
FeaturesetVersions_CreateOrUpdate (new)
Description :  Create or update version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{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 ,
body:
{
Description: Version entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
entities:
{
Description: Specifies list of entities ,
Required: False ,
}
[
string ,
]
,
materializationSettings:
{
Description: Specifies the materialization settings ,
Required: False ,
}
{
notification:
{
Description: Specifies the notification details ,
Required: False ,
}
{
emailOn:
{
Description: Send email notification to user on specified notification type ,
Required: False ,
}
[
string ,
]
,
emails:
{
Description: This is the email recipient list which has a limitation of 499 characters in total concat with comma separator ,
Required: False ,
}
[
string ,
]
,
webhooks:
{
Description: Send webhook callback to a service. Key is a user-provided name for the webhook. ,
Required: False ,
}
object ,
}
,
resource:
{
Description: Specifies the compute resource settings ,
Required: False ,
}
{
instanceType:
{
Description: Specifies the instance type ,
Required: False ,
}
string ,
}
,
schedule:
{
Description: Specifies the schedule details ,
Required: False ,
}
{
frequency:
{
Description: [Required] The frequency to trigger schedule. ,
Enum:
{
Minute: Minute frequency ,
Hour: Hour frequency ,
Day: Day frequency ,
Week: Week frequency ,
Month: Month frequency ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: [Required] Specifies schedule interval in conjunction with frequency ,
Format: int32 ,
Required: True ,
}
integer ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
hours:
{
Description: [Required] List of hours for the schedule. ,
Required: True ,
}
[
integer ,
]
,
minutes:
{
Description: [Required] List of minutes for the schedule. ,
Required: True ,
}
[
integer ,
]
,
monthDays:
{
Description: List of month days for the schedule ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: List of days for the schedule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
sparkConfiguration:
{
Description: Specifies the spark compute settings ,
Required: False ,
}
object ,
storeType:
{
Description: Specifies the stores to which materialization should happen ,
Enum:
{
None: No description available. ,
Online: No description available. ,
Offline: No description available. ,
OnlineAndOffline: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state for the featureset version container. ,
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 ,
specification:
{
Description: Specifies the feature spec details ,
Required: False ,
}
{
path:
{
Description: Specifies the spec path ,
Required: False ,
}
string ,
}
,
stage:
{
Description: Specifies the asset stage ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
entities:
{
Description: Specifies list of entities ,
Required: False ,
}
[
string ,
]
,
materializationSettings:
{
Description: Specifies the materialization settings ,
Required: False ,
}
{
notification:
{
Description: Specifies the notification details ,
Required: False ,
}
{
emailOn:
{
Description: Send email notification to user on specified notification type ,
Required: False ,
}
[
string ,
]
,
emails:
{
Description: This is the email recipient list which has a limitation of 499 characters in total concat with comma separator ,
Required: False ,
}
[
string ,
]
,
webhooks:
{
Description: Send webhook callback to a service. Key is a user-provided name for the webhook. ,
Required: False ,
}
object ,
}
,
resource:
{
Description: Specifies the compute resource settings ,
Required: False ,
}
{
instanceType:
{
Description: Specifies the instance type ,
Required: False ,
}
string ,
}
,
schedule:
{
Description: Specifies the schedule details ,
Required: False ,
}
{
frequency:
{
Description: [Required] The frequency to trigger schedule. ,
Enum:
{
Minute: Minute frequency ,
Hour: Hour frequency ,
Day: Day frequency ,
Week: Week frequency ,
Month: Month frequency ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: [Required] Specifies schedule interval in conjunction with frequency ,
Format: int32 ,
Required: True ,
}
integer ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
hours:
{
Description: [Required] List of hours for the schedule. ,
Required: True ,
}
[
integer ,
]
,
minutes:
{
Description: [Required] List of minutes for the schedule. ,
Required: True ,
}
[
integer ,
]
,
monthDays:
{
Description: List of month days for the schedule ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: List of days for the schedule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
sparkConfiguration:
{
Description: Specifies the spark compute settings ,
Required: False ,
}
object ,
storeType:
{
Description: Specifies the stores to which materialization should happen ,
Enum:
{
None: No description available. ,
Online: No description available. ,
Offline: No description available. ,
OnlineAndOffline: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state for the featureset version container. ,
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 ,
specification:
{
Description: Specifies the feature spec details ,
Required: False ,
}
{
path:
{
Description: Specifies the spec path ,
Required: False ,
}
string ,
}
,
stage:
{
Description: Specifies the asset stage ,
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 ,
}
{
entities:
{
Description: Specifies list of entities ,
Required: False ,
}
[
string ,
]
,
materializationSettings:
{
Description: Specifies the materialization settings ,
Required: False ,
}
{
notification:
{
Description: Specifies the notification details ,
Required: False ,
}
{
emailOn:
{
Description: Send email notification to user on specified notification type ,
Required: False ,
}
[
string ,
]
,
emails:
{
Description: This is the email recipient list which has a limitation of 499 characters in total concat with comma separator ,
Required: False ,
}
[
string ,
]
,
webhooks:
{
Description: Send webhook callback to a service. Key is a user-provided name for the webhook. ,
Required: False ,
}
object ,
}
,
resource:
{
Description: Specifies the compute resource settings ,
Required: False ,
}
{
instanceType:
{
Description: Specifies the instance type ,
Required: False ,
}
string ,
}
,
schedule:
{
Description: Specifies the schedule details ,
Required: False ,
}
{
frequency:
{
Description: [Required] The frequency to trigger schedule. ,
Enum:
{
Minute: Minute frequency ,
Hour: Hour frequency ,
Day: Day frequency ,
Week: Week frequency ,
Month: Month frequency ,
}
,
Required: True ,
}
enum ,
interval:
{
Description: [Required] Specifies schedule interval in conjunction with frequency ,
Format: int32 ,
Required: True ,
}
integer ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
hours:
{
Description: [Required] List of hours for the schedule. ,
Required: True ,
}
[
integer ,
]
,
minutes:
{
Description: [Required] List of minutes for the schedule. ,
Required: True ,
}
[
integer ,
]
,
monthDays:
{
Description: List of month days for the schedule ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: List of days for the schedule. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
sparkConfiguration:
{
Description: Specifies the spark compute settings ,
Required: False ,
}
object ,
storeType:
{
Description: Specifies the stores to which materialization should happen ,
Enum:
{
None: No description available. ,
Online: No description available. ,
Offline: No description available. ,
OnlineAndOffline: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: Provisioning state for the featureset version container. ,
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 ,
specification:
{
Description: Specifies the feature spec details ,
Required: False ,
}
{
path:
{
Description: Specifies the spec path ,
Required: False ,
}
string ,
}
,
stage:
{
Description: Specifies the asset stage ,
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 ,
}
,
]
,
}
,
}
FeaturesetVersions_Backfill (new)
Description :  Backfill.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets/{name}/versions/{version}/backfill
{
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 ,
body:
{
Description: Feature set version backfill request entity. ,
Required: True ,
}
{
dataAvailabilityStatus:
{
Description: Specified the data availability status that you want to backfill ,
Required: False ,
}
[
string ,
]
,
description:
{
Description: Specifies description ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies description ,
Required: False ,
}
string ,
featureWindow:
{
Description: Specifies the backfill feature window to be materialized ,
Required: False ,
}
{
featureWindowEnd:
{
Description: Specifies the feature window end time ,
Format: date-time ,
Required: False ,
}
string ,
featureWindowStart:
{
Description: Specifies the feature window start time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
jobId:
{
Description: Specify the jobId to retry the failed materialization ,
Required: False ,
}
string ,
properties:
{
Description: Specifies the properties ,
Required: False ,
}
object ,
resource:
{
Description: Specifies the compute resource settings ,
Required: False ,
}
{
instanceType:
{
Description: Specifies the instance type ,
Required: False ,
}
string ,
}
,
sparkConfiguration:
{
Description: Specifies the spark compute settings ,
Required: False ,
}
object ,
tags:
{
Description: Specifies the tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
jobIds:
{
Description: List of jobs submitted as part of the backfill request. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
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 ,
}
,
]
,
}
,
}
FeaturestoreEntityContainers_List (new)
Description :  List featurestore entity containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
tags:
{
Description: Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2 ,
Required: False ,
}
string ,
listViewType:
{
Description: [ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities. ,
Required: False ,
}
string ,
pageSize:
{
Description: page size ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: name for the featurestore entity ,
Required: False ,
}
string ,
description:
{
Description: description for the featurestore entity ,
Required: False ,
}
string ,
createdBy:
{
Description: createdBy user name ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of FeaturestoreEntityContainer objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type FeaturestoreEntityContainer. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the featurestore entity container. ,
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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
FeaturestoreEntityContainers_Delete (new)
Description :  Delete container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}
{
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 ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
FeaturestoreEntityContainers_GetEntity (new)
Description :  Get container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the featurestore entity container. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
FeaturestoreEntityContainers_CreateOrUpdate (new)
Description :  Create or update container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{name}
{
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 ,
body:
{
Description: Container entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the featurestore entity container. ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
provisioningState:
{
Description: Provisioning state for the featurestore entity container. ,
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 ,
}
,
}

⚐ 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 ,
}
{
provisioningState:
{
Description: Provisioning state for the featurestore entity container. ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
FeaturestoreEntityVersions_List (new)
Description :  List versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{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: Feature entity name. This is case-sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
tags:
{
Description: Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2 ,
Required: False ,
}
string ,
listViewType:
{
Description: [ListViewType.ActiveOnly, ListViewType.ArchivedOnly, ListViewType.All]View type for including/excluding (for example) archived entities. ,
Required: False ,
}
string ,
pageSize:
{
Description: page size ,
Format: int32 ,
Required: False ,
}
integer ,
versionName:
{
Description: name for the featurestore entity version ,
Required: False ,
}
string ,
version:
{
Description: featurestore entity version ,
Required: False ,
}
string ,
description:
{
Description: description for the feature entity version ,
Required: False ,
}
string ,
createdBy:
{
Description: createdBy user name ,
Required: False ,
}
string ,
stage:
{
Description: Specifies the featurestore stage ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of FeaturestoreEntityVersion objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type FeaturestoreEntityVersion. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
indexColumns:
{
Description: Specifies index columns ,
Required: False ,
}
[
{
columnName:
{
Description: Specifies the column name ,
Required: False ,
}
string ,
dataType:
{
Description: Specifies the data type ,
Enum:
{
String: No description available. ,
Integer: No description available. ,
Long: No description available. ,
Float: No description available. ,
Double: No description available. ,
Binary: No description available. ,
Datetime: No description available. ,
Boolean: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: Provisioning state for the featurestore entity 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: Specifies the asset stage ,
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 ,
}
,
]
,
}
,
}
FeaturestoreEntityVersions_Delete (new)
Description :  Delete version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{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)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
FeaturestoreEntityVersions_Get (new)
Description :  Get version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{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 ,
}
{
indexColumns:
{
Description: Specifies index columns ,
Required: False ,
}
[
{
columnName:
{
Description: Specifies the column name ,
Required: False ,
}
string ,
dataType:
{
Description: Specifies the data type ,
Enum:
{
String: No description available. ,
Integer: No description available. ,
Long: No description available. ,
Float: No description available. ,
Double: No description available. ,
Binary: No description available. ,
Datetime: No description available. ,
Boolean: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: Provisioning state for the featurestore entity 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: Specifies the asset stage ,
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 ,
}
,
]
,
}
,
}
FeaturestoreEntityVersions_CreateOrUpdate (new)
Description :  Create or update version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featurestoreEntities/{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 ,
body:
{
Description: Version entity to create or update. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
indexColumns:
{
Description: Specifies index columns ,
Required: False ,
}
[
{
columnName:
{
Description: Specifies the column name ,
Required: False ,
}
string ,
dataType:
{
Description: Specifies the data type ,
Enum:
{
String: No description available. ,
Integer: No description available. ,
Long: No description available. ,
Float: No description available. ,
Double: No description available. ,
Binary: No description available. ,
Datetime: No description available. ,
Boolean: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: Provisioning state for the featurestore entity 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: Specifies the asset stage ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
indexColumns:
{
Description: Specifies index columns ,
Required: False ,
}
[
{
columnName:
{
Description: Specifies the column name ,
Required: False ,
}
string ,
dataType:
{
Description: Specifies the data type ,
Enum:
{
String: No description available. ,
Integer: No description available. ,
Long: No description available. ,
Float: No description available. ,
Double: No description available. ,
Binary: No description available. ,
Datetime: No description available. ,
Boolean: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: Provisioning state for the featurestore entity 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: Specifies the asset stage ,
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 ,
}
{
indexColumns:
{
Description: Specifies index columns ,
Required: False ,
}
[
{
columnName:
{
Description: Specifies the column name ,
Required: False ,
}
string ,
dataType:
{
Description: Specifies the data type ,
Enum:
{
String: No description available. ,
Integer: No description available. ,
Long: No description available. ,
Float: No description available. ,
Double: No description available. ,
Binary: No description available. ,
Datetime: No description available. ,
Boolean: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: Provisioning state for the featurestore entity 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: Specifies the asset stage ,
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 ,
}
,
]
,
}
,
}
InferencePools_List (new)
Description :  List InferencePools.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
count:
{
Description: Number of inferencePools to be retrieved in a page of results. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
tags:
{
Description: A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 . ,
Required: False ,
}
string ,
properties:
{
Description: A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 . ,
Required: False ,
}
string ,
orderBy:
{
Description: The option to order the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of InferencePool objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type InferencePool. ,
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 ,
}
{
provisioningState:
{
Description: Provisioning state for the pool. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scaleUnitConfiguration:
{
Description: Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
disablePublicEgress:
{
Description: Gets or sets a value indicating whether PublicEgress is disabled. ,
Required: False ,
}
boolean ,
registries:
{
Description: Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
,
]
,
}
,
}
InferencePools_Delete (new)
Description :  Delete InferencePool (asynchronous).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{inferencePoolName}
{
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 ,
inferencePoolName:
{
Description: Name of InferencePool ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
InferencePools_Get (new)
Description :  Get InferencePool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{inferencePoolName}
{
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 ,
inferencePoolName:
{
Description: Name of InferencePool ,
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 ,
}
{
provisioningState:
{
Description: Provisioning state for the pool. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scaleUnitConfiguration:
{
Description: Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
disablePublicEgress:
{
Description: Gets or sets a value indicating whether PublicEgress is disabled. ,
Required: False ,
}
boolean ,
registries:
{
Description: Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
,
]
,
}
,
}
InferencePools_Update (new)
Description :  Update InferencePool (asynchronous).
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{inferencePoolName}
{
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 ,
inferencePoolName:
{
Description: Name of InferencePool ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Inference Pool entity to apply during operation. ,
Required: True ,
}
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
type:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
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 ,
}
{
provisioningState:
{
Description: Provisioning state for the pool. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scaleUnitConfiguration:
{
Description: Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
disablePublicEgress:
{
Description: Gets or sets a value indicating whether PublicEgress is disabled. ,
Required: False ,
}
boolean ,
registries:
{
Description: Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
,
]
,
}
,
}
InferencePools_CreateOrUpdate (new)
Description :  Create or update InferencePool (asynchronous).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{inferencePoolName}
{
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 ,
inferencePoolName:
{
Description: Name of InferencePool ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: InferencePool 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 ,
}
{
provisioningState:
{
Description: Provisioning state for the pool. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scaleUnitConfiguration:
{
Description: Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
disablePublicEgress:
{
Description: Gets or sets a value indicating whether PublicEgress is disabled. ,
Required: False ,
}
boolean ,
registries:
{
Description: Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
{
provisioningState:
{
Description: Provisioning state for the pool. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scaleUnitConfiguration:
{
Description: Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
disablePublicEgress:
{
Description: Gets or sets a value indicating whether PublicEgress is disabled. ,
Required: False ,
}
boolean ,
registries:
{
Description: Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
{
provisioningState:
{
Description: Provisioning state for the pool. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scaleUnitConfiguration:
{
Description: Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
disablePublicEgress:
{
Description: Gets or sets a value indicating whether PublicEgress is disabled. ,
Required: False ,
}
boolean ,
registries:
{
Description: Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
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 ,
}
,
]
,
}
,
}
InferenceEndpoints_List (new)
Description :  List Inference Endpoints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/endpoints
{
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 ,
poolName:
{
Description: Name of the InferencePool. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
count:
{
Description: Number of InferenceEndpoint to be retrieved in a page of results. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
tags:
{
Description: A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 . ,
Required: False ,
}
string ,
properties:
{
Description: A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 . ,
Required: False ,
}
string ,
orderBy:
{
Description: The option to order the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of InferenceEndpoint objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type InferenceEndpoint. ,
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 ,
}
{
authMode:
{
Description: [Required] Authentication mode for the endpoint. ,
Enum:
{
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
endpointUri:
{
Description: Endpoint URI for the inference endpoint. ,
Format: uri ,
Required: False ,
}
string ,
groupName:
{
Description: [Required] Group within the same pool with which this endpoint needs to be associated with. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
requestConfiguration:
{
Description: RequestConfiguration for endpoint. ,
Required: False ,
}
{
maxConcurrentRequestsPerInstance:
{
Description: The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. ,
Format: int32 ,
Required: False ,
}
integer ,
requestTimeout:
{
Description: The scoring timeout in ISO 8601 format. Defaults to 5000ms. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
}
,
}
InferenceEndpoints_Delete (new)
Description :  Delete InferenceEndpoint (asynchronous).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/endpoints/{endpointName}
{
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 ,
poolName:
{
Description: InferencePool name. ,
Required: True ,
}
string ,
endpointName:
{
Description: InferenceEndpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
InferenceEndpoints_Get (new)
Description :  Get InferenceEndpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/endpoints/{endpointName}
{
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 ,
poolName:
{
Description: InferencePool name. ,
Required: True ,
}
string ,
endpointName:
{
Description: InferenceEndpoint 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 ,
}
{
authMode:
{
Description: [Required] Authentication mode for the endpoint. ,
Enum:
{
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
endpointUri:
{
Description: Endpoint URI for the inference endpoint. ,
Format: uri ,
Required: False ,
}
string ,
groupName:
{
Description: [Required] Group within the same pool with which this endpoint needs to be associated with. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
requestConfiguration:
{
Description: RequestConfiguration for endpoint. ,
Required: False ,
}
{
maxConcurrentRequestsPerInstance:
{
Description: The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. ,
Format: int32 ,
Required: False ,
}
integer ,
requestTimeout:
{
Description: The scoring timeout in ISO 8601 format. Defaults to 5000ms. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
}
,
}
InferenceEndpoints_Update (new)
Description :  Update InferenceEndpoint (asynchronous).
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/endpoints/{endpointName}
{
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 ,
poolName:
{
Description: InferencePool name. ,
Required: True ,
}
string ,
endpointName:
{
Description: InferenceEndpoint 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 ,
}
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 ,
}
{
authMode:
{
Description: [Required] Authentication mode for the endpoint. ,
Enum:
{
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
endpointUri:
{
Description: Endpoint URI for the inference endpoint. ,
Format: uri ,
Required: False ,
}
string ,
groupName:
{
Description: [Required] Group within the same pool with which this endpoint needs to be associated with. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
requestConfiguration:
{
Description: RequestConfiguration for endpoint. ,
Required: False ,
}
{
maxConcurrentRequestsPerInstance:
{
Description: The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. ,
Format: int32 ,
Required: False ,
}
integer ,
requestTimeout:
{
Description: The scoring timeout in ISO 8601 format. Defaults to 5000ms. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
}
,
}
InferenceEndpoints_CreateOrUpdate (new)
Description :  Create or update InferenceEndpoint (asynchronous).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/endpoints/{endpointName}
{
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 ,
poolName:
{
Description: InferencePool name. ,
Required: True ,
}
string ,
endpointName:
{
Description: InferenceEndpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: InferenceEndpoint 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 ,
}
{
authMode:
{
Description: [Required] Authentication mode for the endpoint. ,
Enum:
{
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
endpointUri:
{
Description: Endpoint URI for the inference endpoint. ,
Format: uri ,
Required: False ,
}
string ,
groupName:
{
Description: [Required] Group within the same pool with which this endpoint needs to be associated with. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
requestConfiguration:
{
Description: RequestConfiguration for endpoint. ,
Required: False ,
}
{
maxConcurrentRequestsPerInstance:
{
Description: The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. ,
Format: int32 ,
Required: False ,
}
integer ,
requestTimeout:
{
Description: The scoring timeout in ISO 8601 format. Defaults to 5000ms. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
{
authMode:
{
Description: [Required] Authentication mode for the endpoint. ,
Enum:
{
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
endpointUri:
{
Description: Endpoint URI for the inference endpoint. ,
Format: uri ,
Required: False ,
}
string ,
groupName:
{
Description: [Required] Group within the same pool with which this endpoint needs to be associated with. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
requestConfiguration:
{
Description: RequestConfiguration for endpoint. ,
Required: False ,
}
{
maxConcurrentRequestsPerInstance:
{
Description: The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. ,
Format: int32 ,
Required: False ,
}
integer ,
requestTimeout:
{
Description: The scoring timeout in ISO 8601 format. Defaults to 5000ms. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
{
authMode:
{
Description: [Required] Authentication mode for the endpoint. ,
Enum:
{
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
endpointUri:
{
Description: Endpoint URI for the inference endpoint. ,
Format: uri ,
Required: False ,
}
string ,
groupName:
{
Description: [Required] Group within the same pool with which this endpoint needs to be associated with. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
requestConfiguration:
{
Description: RequestConfiguration for endpoint. ,
Required: False ,
}
{
maxConcurrentRequestsPerInstance:
{
Description: The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. ,
Format: int32 ,
Required: False ,
}
integer ,
requestTimeout:
{
Description: The scoring timeout in ISO 8601 format. Defaults to 5000ms. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
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 ,
}
,
]
,
}
,
}
InferenceGroups_List (new)
Description :  List Inference Groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups
{
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 ,
poolName:
{
Description: Name of the InferencePool. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
count:
{
Description: Number of InferenceGroup to be retrieved in a page of results. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
tags:
{
Description: A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 . ,
Required: False ,
}
string ,
properties:
{
Description: A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 . ,
Required: False ,
}
string ,
orderBy:
{
Description: The option to order the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of InferenceGroup objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type InferenceGroup. ,
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 ,
}
{
environmentConfiguration:
{
Description: Gets or sets environment configuration for the inference group. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
environmentId:
{
Description: ARM resource ID of the environment specification for the inference pool. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: Environment variables configuration for the inference pool. ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
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 ,
}
,
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: 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. ,
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 ,
}
,
}
,
modelConfiguration:
{
Description: Gets or sets model configuration for the inference group. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
modelId:
{
Description: The URI path to the model. ,
Required: False ,
}
string ,
}
,
nodeSkuType:
{
Description: Gets or sets compute instance type. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the inference group. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scaleUnitSize:
{
Description: Gets or sets Scale Unit size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
}
,
]
,
}
,
}
InferenceGroups_Delete (new)
Description :  Delete InferenceGroup (asynchronous).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups/{groupName}
{
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 ,
poolName:
{
Description: InferencePool name. ,
Required: True ,
}
string ,
groupName:
{
Description: InferenceGroup name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
InferenceGroups_Get (new)
Description :  Get InferenceGroup.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups/{groupName}
{
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 ,
poolName:
{
Description: InferencePool name. ,
Required: True ,
}
string ,
groupName:
{
Description: InferenceGroup 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 ,
}
{
environmentConfiguration:
{
Description: Gets or sets environment configuration for the inference group. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
environmentId:
{
Description: ARM resource ID of the environment specification for the inference pool. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: Environment variables configuration for the inference pool. ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
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 ,
}
,
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: 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. ,
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 ,
}
,
}
,
modelConfiguration:
{
Description: Gets or sets model configuration for the inference group. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
modelId:
{
Description: The URI path to the model. ,
Required: False ,
}
string ,
}
,
nodeSkuType:
{
Description: Gets or sets compute instance type. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the inference group. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scaleUnitSize:
{
Description: Gets or sets Scale Unit size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
}
,
]
,
}
,
}
InferenceGroups_Update (new)
Description :  Update InferenceGroup (asynchronous).
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups/{groupName}
{
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 ,
poolName:
{
Description: InferencePool name. ,
Required: True ,
}
string ,
groupName:
{
Description: InferenceGroup 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 ,
}
{
environmentConfiguration:
{
Description: Gets or sets environment configuration for the inference group. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
environmentId:
{
Description: ARM resource ID of the environment specification for the inference pool. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: Environment variables configuration for the inference pool. ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
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 ,
}
,
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: 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. ,
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 ,
}
,
}
,
modelConfiguration:
{
Description: Gets or sets model configuration for the inference group. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
modelId:
{
Description: The URI path to the model. ,
Required: False ,
}
string ,
}
,
nodeSkuType:
{
Description: Gets or sets compute instance type. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the inference group. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scaleUnitSize:
{
Description: Gets or sets Scale Unit size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
}
,
]
,
}
,
}
InferenceGroups_CreateOrUpdate (new)
Description :  Create or update InferenceGroup (asynchronous).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups/{groupName}
{
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 ,
poolName:
{
Description: InferencePool name. ,
Required: True ,
}
string ,
groupName:
{
Description: InferenceGroup name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: InferenceGroup 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 ,
}
{
environmentConfiguration:
{
Description: Gets or sets environment configuration for the inference group. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
environmentId:
{
Description: ARM resource ID of the environment specification for the inference pool. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: Environment variables configuration for the inference pool. ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
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 ,
}
,
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: 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. ,
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 ,
}
,
}
,
modelConfiguration:
{
Description: Gets or sets model configuration for the inference group. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
modelId:
{
Description: The URI path to the model. ,
Required: False ,
}
string ,
}
,
nodeSkuType:
{
Description: Gets or sets compute instance type. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the inference group. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scaleUnitSize:
{
Description: Gets or sets Scale Unit size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
}
{
environmentConfiguration:
{
Description: Gets or sets environment configuration for the inference group. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
environmentId:
{
Description: ARM resource ID of the environment specification for the inference pool. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: Environment variables configuration for the inference pool. ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
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 ,
}
,
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: 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. ,
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 ,
}
,
}
,
modelConfiguration:
{
Description: Gets or sets model configuration for the inference group. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
modelId:
{
Description: The URI path to the model. ,
Required: False ,
}
string ,
}
,
nodeSkuType:
{
Description: Gets or sets compute instance type. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the inference group. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scaleUnitSize:
{
Description: Gets or sets Scale Unit size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
}
{
environmentConfiguration:
{
Description: Gets or sets environment configuration for the inference group. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
environmentId:
{
Description: ARM resource ID of the environment specification for the inference pool. ,
Required: False ,
}
string ,
environmentVariables:
{
Description: Environment variables configuration for the inference pool. ,
Required: False ,
}
[
{
key:
{
Required: False ,
}
string ,
value:
{
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 ,
}
,
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: 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. ,
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 ,
}
,
}
,
modelConfiguration:
{
Description: Gets or sets model configuration for the inference group. Used if PoolType=ScaleUnit. ,
Required: False ,
}
{
modelId:
{
Description: The URI path to the model. ,
Required: False ,
}
string ,
}
,
nodeSkuType:
{
Description: Gets or sets compute instance type. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the inference group. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
scaleUnitSize:
{
Description: Gets or sets Scale Unit size. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
}
,
]
,
}
,
}
InferenceGroups_GetDeltaModelsStatusAsync (new)
Description :  Retrieve status of delta models associated with the InferenceGroup and the target base model.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups/{groupName}/deltaModels/getStatus
{
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 ,
poolName:
{
Description: InferencePool name. ,
Required: True ,
}
string ,
groupName:
{
Description: InferenceGroup name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: DeltaModelBaseRequest. ,
Required: True ,
}
{
deltaModels:
{
Description: Gets or sets collection of delta models to retrieve status for. ,
Required: False ,
}
[
string ,
]
,
targetBaseModel:
{
Description: Gets or sets target base model. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
actualInstanceCount:
{
Description: Gets or sets actual instance count. ,
Format: int32 ,
Required: False ,
}
integer ,
deltaModels:
{
Description: Gets or sets dictionary representing modelID and its current state. ,
Required: False ,
}
object ,
expectedInstanceCount:
{
Description: Gets or sets expected instance count. ,
Format: int32 ,
Required: False ,
}
integer ,
revisionId:
{
Description: Gets or sets revision ID. ,
Required: False ,
}
string ,
targetBaseModel:
{
Description: Gets or sets target base model. ,
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 ,
}
,
]
,
}
,
}
InferenceGroups_ListDeltaModelsAsync (new)
Description :  List delta models associated with the InferenceGroup and the target base model.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups/{groupName}/deltaModels/list
{
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 ,
poolName:
{
Description: InferencePool name. ,
Required: True ,
}
string ,
groupName:
{
Description: InferenceGroup name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: DeltaModelBaseRequest. ,
Required: True ,
}
{
count:
{
Description: Gets or sets number of delta models to return. Default: -1, means that all will be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
skipToken:
{
Description: Gets or sets skip token for paginated response. ,
Required: False ,
}
string ,
targetBaseModel:
{
Description: Gets or sets target base model. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of String objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type String. ,
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 ,
}
,
]
,
}
,
}
InferenceGroups_ModifyDeltaModelsAsync (new)
Description :  Modify delta models associated with the InferenceGroup and the target base model.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups/{groupName}/deltaModels/modify
{
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 ,
poolName:
{
Description: InferencePool name. ,
Required: True ,
}
string ,
groupName:
{
Description: InferenceGroup name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: DeltaModelModifyRequest. ,
Required: True ,
}
{
addDeltaModels:
{
Description: Gets or sets delta models to remove. ,
Required: False ,
}
[
string ,
]
,
removeDeltaModels:
{
Description: Gets or sets delta models to remove. ,
Required: False ,
}
[
string ,
]
,
targetBaseModel:
{
Description: Gets or sets target base model. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
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 ,
}
,
]
,
}
,
}
InferenceGroups_GetStatus (new)
Description :  Retrieve inference group status.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups/{groupName}/getStatus
{
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 ,
poolName:
{
Description: InferencePool name. ,
Required: True ,
}
string ,
groupName:
{
Description: InferenceGroup name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
actualCapacityInfo:
{
Description: Gets or sets the actual capacity info for the group. ,
Required: False ,
}
{
total:
{
Description: Gets or sets the total number of instances (scale units) regardless of provisioning state or whether current group payload version matches the target group payload. ,
Format: int32 ,
Required: False ,
}
integer ,
succeeded:
{
Description: Gets or sets the number of instances (scale units) which have Succeeded provisioning state and target group payload. ,
Format: int32 ,
Required: False ,
}
integer ,
failed:
{
Description: Gets or sets the number of instances (scale units) which have Failed provisioning state and have target group payload. ,
Format: int32 ,
Required: False ,
}
integer ,
outdatedSucceeded:
{
Description: Gets or sets the number of instances (scale units) which have Succeeded provisioning state but do not have target group payload. ,
Format: int32 ,
Required: False ,
}
integer ,
outdatedFailed:
{
Description: Gets or sets the number of instances (scale units) which have Failed provisioning state but do not have target group payload. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
endpointCount:
{
Description: Gets or sets the actual number of endpoints in the group. ,
Format: int32 ,
Required: False ,
}
integer ,
requestedCapacity:
{
Description: Gets or sets the request number of instances for the group. ,
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 ,
}
,
]
,
}
,
}
InferenceGroups_ListSkus (new)
Description :  List Inference Group Skus.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/inferencePools/{poolName}/groups/{groupName}/skus
{
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 ,
poolName:
{
Description: Inference Pool name. ,
Required: True ,
}
string ,
groupName:
{
Description: Inference Group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
count:
{
Description: Number of Skus to be retrieved in a page of results. ,
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 SkuResource objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type SkuResource. ,
Required: False ,
}
[
{
capacity:
{
Description: Gets or sets the Sku Capacity. ,
Required: False ,
}
{
default:
{
Description: Gets or sets the default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: Gets or sets the maximum. ,
Format: int32 ,
Required: False ,
}
integer ,
minimum:
{
Description: Gets or sets the minimum. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: Gets or sets the type of the scale. ,
Enum:
{
Automatic: Automatically scales node count. ,
Manual: Node count scaled upon user request. ,
None: Fixed set of nodes. ,
}
,
Required: False ,
}
enum ,
}
,
resourceType:
{
Description: The resource type name. ,
Required: False ,
}
string ,
sku:
{
Description: Gets or sets the Sku. ,
Required: False ,
}
{
name:
{
Description: [Required] 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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Jobs_List (new)
Description :  Lists Jobs in the workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
jobType:
{
Description: Type of job to be returned. ,
Required: False ,
}
string ,
tag:
{
Description: Jobs returned will have this tag key. ,
Required: False ,
}
string ,
listViewType:
{
Description: View type for including/excluding (for example) archived entities. ,
Required: False ,
}
string ,
properties:
{
Description: Comma-separated list of user property names (and optionally values). Example: prop1,prop2=value2 ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of JobBase objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type JobBase. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
componentId:
{
Description: ARM resource ID of the component resource. ,
Required: False ,
}
string ,
computeId:
{
Description: ARM resource ID of the compute resource. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of job. ,
Required: False ,
}
string ,
experimentName:
{
Description: The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. ,
Required: False ,
}
string ,
identity:
{
Description: Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null. ,
Required: False ,
}
{
identityType:
{
Description: [Required] Specifies the type of identity framework. ,
Enum:
{
Managed: No description available. ,
AMLToken: No description available. ,
UserIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isArchived:
{
Description: Is the asset archived? ,
Required: False ,
}
boolean ,
jobType:
{
Description: [Required] Specifies the type of job. ,
Enum:
{
AutoML: No description available. ,
Command: No description available. ,
Sweep: No description available. ,
Pipeline: No description available. ,
Spark: No description available. ,
FineTuning: No description available. ,
Distillation: No description available. ,
}
,
Required: True ,
}
enum ,
notificationSetting:
{
Description: Notification setting for the job ,
Required: False ,
}
{
emailOn:
{
Description: Send email notification to user on specified notification type ,
Required: False ,
}
[
string ,
]
,
emails:
{
Description: This is the email recipient list which has a limitation of 499 characters in total concat with comma separator ,
Required: False ,
}
[
string ,
]
,
webhooks:
{
Description: Send webhook callback to a service. Key is a user-provided name for the webhook. ,
Required: False ,
}
object ,
}
,
parentJobName:
{
Description: Parent job name. ,
Required: False ,
}
string ,
services:
{
Description: List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject. ,
Required: False ,
}
object ,
status:
{
Description: Status of the job. ,
Enum:
{
NotStarted: Run hasn't started yet. ,
Starting: Run has started. The user has a run ID. ,
Provisioning: (Not used currently) It will be used if ES is creating the compute target. ,
Preparing: The run environment is being prepared. ,
Queued: The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting for all required nodes to be ready. ,
Running: The job started to run in the compute target. ,
Finalizing: Job is completed in the target. It is in output collection state now. ,
CancelRequested: Cancellation has been requested for the job. ,
Completed: Job completed successfully. This reflects that both the job itself and output collection states completed successfully ,
Failed: Job failed. ,
Canceled: Following cancellation request, the job is now successfully canceled. ,
NotResponding: When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run goes to NotResponding state. NotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of the previous states. ,
Paused: The job is paused by users. Some adjustment to labeling jobs can be made only in paused state. ,
Unknown: Default job status if not mapped to all other statuses ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Jobs_Delete (new)
Description :  Deletes a Job (asynchronous).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}
{
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 ,
id:
{
Description: The name and identifier for the Job. This is case-sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Jobs_Get (new)
Description :  Gets a Job by name/id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}
{
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 ,
id:
{
Description: The name and identifier for the Job. 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 ,
}
{
componentId:
{
Description: ARM resource ID of the component resource. ,
Required: False ,
}
string ,
computeId:
{
Description: ARM resource ID of the compute resource. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of job. ,
Required: False ,
}
string ,
experimentName:
{
Description: The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. ,
Required: False ,
}
string ,
identity:
{
Description: Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null. ,
Required: False ,
}
{
identityType:
{
Description: [Required] Specifies the type of identity framework. ,
Enum:
{
Managed: No description available. ,
AMLToken: No description available. ,
UserIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isArchived:
{
Description: Is the asset archived? ,
Required: False ,
}
boolean ,
jobType:
{
Description: [Required] Specifies the type of job. ,
Enum:
{
AutoML: No description available. ,
Command: No description available. ,
Sweep: No description available. ,
Pipeline: No description available. ,
Spark: No description available. ,
FineTuning: No description available. ,
Distillation: No description available. ,
}
,
Required: True ,
}
enum ,
notificationSetting:
{
Description: Notification setting for the job ,
Required: False ,
}
{
emailOn:
{
Description: Send email notification to user on specified notification type ,
Required: False ,
}
[
string ,
]
,
emails:
{
Description: This is the email recipient list which has a limitation of 499 characters in total concat with comma separator ,
Required: False ,
}
[
string ,
]
,
webhooks:
{
Description: Send webhook callback to a service. Key is a user-provided name for the webhook. ,
Required: False ,
}
object ,
}
,
parentJobName:
{
Description: Parent job name. ,
Required: False ,
}
string ,
services:
{
Description: List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject. ,
Required: False ,
}
object ,
status:
{
Description: Status of the job. ,
Enum:
{
NotStarted: Run hasn't started yet. ,
Starting: Run has started. The user has a run ID. ,
Provisioning: (Not used currently) It will be used if ES is creating the compute target. ,
Preparing: The run environment is being prepared. ,
Queued: The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting for all required nodes to be ready. ,
Running: The job started to run in the compute target. ,
Finalizing: Job is completed in the target. It is in output collection state now. ,
CancelRequested: Cancellation has been requested for the job. ,
Completed: Job completed successfully. This reflects that both the job itself and output collection states completed successfully ,
Failed: Job failed. ,
Canceled: Following cancellation request, the job is now successfully canceled. ,
NotResponding: When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run goes to NotResponding state. NotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of the previous states. ,
Paused: The job is paused by users. Some adjustment to labeling jobs can be made only in paused state. ,
Unknown: Default job status if not mapped to all other statuses ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Jobs_CreateOrUpdate (new)
Description :  Creates and executes a Job. For update case, the Tags in the definition passed in will replace Tags in the existing job.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}
{
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 ,
id:
{
Description: The name and identifier for the Job. This is case-sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Job definition object. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
componentId:
{
Description: ARM resource ID of the component resource. ,
Required: False ,
}
string ,
computeId:
{
Description: ARM resource ID of the compute resource. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of job. ,
Required: False ,
}
string ,
experimentName:
{
Description: The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. ,
Required: False ,
}
string ,
identity:
{
Description: Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null. ,
Required: False ,
}
{
identityType:
{
Description: [Required] Specifies the type of identity framework. ,
Enum:
{
Managed: No description available. ,
AMLToken: No description available. ,
UserIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isArchived:
{
Description: Is the asset archived? ,
Required: False ,
}
boolean ,
jobType:
{
Description: [Required] Specifies the type of job. ,
Enum:
{
AutoML: No description available. ,
Command: No description available. ,
Sweep: No description available. ,
Pipeline: No description available. ,
Spark: No description available. ,
FineTuning: No description available. ,
Distillation: No description available. ,
}
,
Required: True ,
}
enum ,
notificationSetting:
{
Description: Notification setting for the job ,
Required: False ,
}
{
emailOn:
{
Description: Send email notification to user on specified notification type ,
Required: False ,
}
[
string ,
]
,
emails:
{
Description: This is the email recipient list which has a limitation of 499 characters in total concat with comma separator ,
Required: False ,
}
[
string ,
]
,
webhooks:
{
Description: Send webhook callback to a service. Key is a user-provided name for the webhook. ,
Required: False ,
}
object ,
}
,
parentJobName:
{
Description: Parent job name. ,
Required: False ,
}
string ,
services:
{
Description: List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject. ,
Required: False ,
}
object ,
status:
{
Description: Status of the job. ,
Enum:
{
NotStarted: Run hasn't started yet. ,
Starting: Run has started. The user has a run ID. ,
Provisioning: (Not used currently) It will be used if ES is creating the compute target. ,
Preparing: The run environment is being prepared. ,
Queued: The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting for all required nodes to be ready. ,
Running: The job started to run in the compute target. ,
Finalizing: Job is completed in the target. It is in output collection state now. ,
CancelRequested: Cancellation has been requested for the job. ,
Completed: Job completed successfully. This reflects that both the job itself and output collection states completed successfully ,
Failed: Job failed. ,
Canceled: Following cancellation request, the job is now successfully canceled. ,
NotResponding: When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run goes to NotResponding state. NotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of the previous states. ,
Paused: The job is paused by users. Some adjustment to labeling jobs can be made only in paused state. ,
Unknown: Default job status if not mapped to all other statuses ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
componentId:
{
Description: ARM resource ID of the component resource. ,
Required: False ,
}
string ,
computeId:
{
Description: ARM resource ID of the compute resource. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of job. ,
Required: False ,
}
string ,
experimentName:
{
Description: The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. ,
Required: False ,
}
string ,
identity:
{
Description: Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null. ,
Required: False ,
}
{
identityType:
{
Description: [Required] Specifies the type of identity framework. ,
Enum:
{
Managed: No description available. ,
AMLToken: No description available. ,
UserIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isArchived:
{
Description: Is the asset archived? ,
Required: False ,
}
boolean ,
jobType:
{
Description: [Required] Specifies the type of job. ,
Enum:
{
AutoML: No description available. ,
Command: No description available. ,
Sweep: No description available. ,
Pipeline: No description available. ,
Spark: No description available. ,
FineTuning: No description available. ,
Distillation: No description available. ,
}
,
Required: True ,
}
enum ,
notificationSetting:
{
Description: Notification setting for the job ,
Required: False ,
}
{
emailOn:
{
Description: Send email notification to user on specified notification type ,
Required: False ,
}
[
string ,
]
,
emails:
{
Description: This is the email recipient list which has a limitation of 499 characters in total concat with comma separator ,
Required: False ,
}
[
string ,
]
,
webhooks:
{
Description: Send webhook callback to a service. Key is a user-provided name for the webhook. ,
Required: False ,
}
object ,
}
,
parentJobName:
{
Description: Parent job name. ,
Required: False ,
}
string ,
services:
{
Description: List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject. ,
Required: False ,
}
object ,
status:
{
Description: Status of the job. ,
Enum:
{
NotStarted: Run hasn't started yet. ,
Starting: Run has started. The user has a run ID. ,
Provisioning: (Not used currently) It will be used if ES is creating the compute target. ,
Preparing: The run environment is being prepared. ,
Queued: The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting for all required nodes to be ready. ,
Running: The job started to run in the compute target. ,
Finalizing: Job is completed in the target. It is in output collection state now. ,
CancelRequested: Cancellation has been requested for the job. ,
Completed: Job completed successfully. This reflects that both the job itself and output collection states completed successfully ,
Failed: Job failed. ,
Canceled: Following cancellation request, the job is now successfully canceled. ,
NotResponding: When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run goes to NotResponding state. NotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of the previous states. ,
Paused: The job is paused by users. Some adjustment to labeling jobs can be made only in paused state. ,
Unknown: Default job status if not mapped to all other statuses ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
componentId:
{
Description: ARM resource ID of the component resource. ,
Required: False ,
}
string ,
computeId:
{
Description: ARM resource ID of the compute resource. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of job. ,
Required: False ,
}
string ,
experimentName:
{
Description: The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. ,
Required: False ,
}
string ,
identity:
{
Description: Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null. ,
Required: False ,
}
{
identityType:
{
Description: [Required] Specifies the type of identity framework. ,
Enum:
{
Managed: No description available. ,
AMLToken: No description available. ,
UserIdentity: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isArchived:
{
Description: Is the asset archived? ,
Required: False ,
}
boolean ,
jobType:
{
Description: [Required] Specifies the type of job. ,
Enum:
{
AutoML: No description available. ,
Command: No description available. ,
Sweep: No description available. ,
Pipeline: No description available. ,
Spark: No description available. ,
FineTuning: No description available. ,
Distillation: No description available. ,
}
,
Required: True ,
}
enum ,
notificationSetting:
{
Description: Notification setting for the job ,
Required: False ,
}
{
emailOn:
{
Description: Send email notification to user on specified notification type ,
Required: False ,
}
[
string ,
]
,
emails:
{
Description: This is the email recipient list which has a limitation of 499 characters in total concat with comma separator ,
Required: False ,
}
[
string ,
]
,
webhooks:
{
Description: Send webhook callback to a service. Key is a user-provided name for the webhook. ,
Required: False ,
}
object ,
}
,
parentJobName:
{
Description: Parent job name. ,
Required: False ,
}
string ,
services:
{
Description: List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject. ,
Required: False ,
}
object ,
status:
{
Description: Status of the job. ,
Enum:
{
NotStarted: Run hasn't started yet. ,
Starting: Run has started. The user has a run ID. ,
Provisioning: (Not used currently) It will be used if ES is creating the compute target. ,
Preparing: The run environment is being prepared. ,
Queued: The job is queued in the compute target. For example, in BatchAI the job is in queued state, while waiting for all required nodes to be ready. ,
Running: The job started to run in the compute target. ,
Finalizing: Job is completed in the target. It is in output collection state now. ,
CancelRequested: Cancellation has been requested for the job. ,
Completed: Job completed successfully. This reflects that both the job itself and output collection states completed successfully ,
Failed: Job failed. ,
Canceled: Following cancellation request, the job is now successfully canceled. ,
NotResponding: When heartbeat is enabled, if the run isn't updating any information to RunHistory then the run goes to NotResponding state. NotResponding is the only state that is exempt from strict transition orders. A run can go from NotResponding to any of the previous states. ,
Paused: The job is paused by users. Some adjustment to labeling jobs can be made only in paused state. ,
Unknown: Default job status if not mapped to all other statuses ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Jobs_Cancel (new)
Description :  Cancels a Job (asynchronous).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/jobs/{id}/cancel
{
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 ,
id:
{
Description: The name and identifier for the Job. This is case-sensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
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 ,
}
,
]
,
}
,
}
MarketplaceSubscriptions_List (new)
Description :  List containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of MarketplaceSubscription objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type MarketplaceSubscription. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
marketplacePlan:
{
Description: Marketplace Plan associated with the Marketplace Subscription. ,
Required: False ,
}
{
offerId:
{
Description: The identifying name of the Offer of the Marketplace Plan. ,
Required: False ,
}
string ,
planId:
{
Description: The identifying name of the Plan of the Marketplace Plan. ,
Required: False ,
}
string ,
publisherId:
{
Description: The identifying name of the Publisher of the Marketplace Plan. ,
Required: False ,
}
string ,
}
,
marketplaceSubscriptionStatus:
{
Description: Current status of the Marketplace Subscription. ,
Enum:
{
Subscribed: The customer can now use the Marketplace Subscription's model and will be billed. ,
Suspended: The customer could not be billed for the Marketplace Subscription. The customer will not be able to access the model. ,
Unsubscribed: Marketplace Subscriptions reach this state in response to an explicit customer or CSP action. A Marketplace Subscription can also be canceled implicitly, as a result of nonpayment of dues, after being in the Suspended state for some time. ,
}
,
Required: False ,
}
enum ,
modelId:
{
Description: [Required] Target Marketplace Model ID to create a Marketplace Subscription for. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State of the Marketplace Subscription. ,
Enum:
{
Creating: MarketplaceSubscription is being created. ,
Deleting: MarketplaceSubscription is being deleted. ,
Succeeded: MarketplaceSubscription is successfully provisioned. ,
Failed: MarketplaceSubscription provisioning failed. ,
Updating: MarketplaceSubscription is being updated. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
MarketplaceSubscriptions_Delete (new)
Description :  Delete Marketplace Subscription (asynchronous).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}
{
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: Marketplace Subscription name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ 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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
MarketplaceSubscriptions_Get (new)
Description :  Get container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/marketplaceSubscriptions/{name}
{
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. ,
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 ,
}
{
marketplacePlan:
{
Description: Marketplace Plan associated with the Marketplace Subscription. ,
Required: False ,
}
{
offerId:
{
Description: The identifying name of the Offer of the Marketplace Plan. ,
Required: False ,
}