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 ,
}
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_CreateOrUpdate (new)
Description :  Create or update Marketplace Subscription (asynchronous).
Reference :  Link ¶

⚼ Request

PUT:  /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 ,
body:
{
Description: Marketplace Subscription entity to apply during operation. ,
Required: True ,
}
{
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 (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 ,
}
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 (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 ,
}
{
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 ,
}
,
]
,
}
,
}
ModelContainers_List (new)
Description :  List model containers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/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 ,
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 ,
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 ,
}
,
]
,
}
,
}
ModelContainers_Delete (new)
Description :  Delete container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{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 ,
}
,
]
,
}
,
}
ModelContainers_Get (new)
Description :  Get container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{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 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 ,
}
,
]
,
}
,
}
ModelContainers_CreateOrUpdate (new)
Description :  Create or update container.
Reference :  Link ¶

⚼ Request

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

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{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: Model 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: Model version. ,
Required: False ,
}
string ,
description:
{
Description: Model description. ,
Required: False ,
}
string ,
offset:
{
Description: Number of initial results to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
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 ,
feed:
{
Description: Name of the feed. ,
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 ,
}
,
]
,
}
,
}
ModelVersions_Delete (new)
Description :  Delete version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{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 ,
}
,
]
,
}
,
}
ModelVersions_Get (new)
Description :  Get version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{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 ,
}
{
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 ,
}
,
]
,
}
,
}
ModelVersions_CreateOrUpdate (new)
Description :  Create or update version.
Reference :  Link ¶

⚼ Request

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

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/models/{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 ,
}
,
]
,
}
,
}
OnlineEndpoints_List (new)
Description :  List Online Endpoints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints
{
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 ,
name:
{
Description: Name of the endpoint. ,
Required: False ,
}
string ,
count:
{
Description: Number of endpoints to be retrieved in a page of results. ,
Format: int32 ,
Required: False ,
}
integer ,
computeType:
{
Description: EndpointComputeType to be filtered by. ,
Required: False ,
}
string ,
$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 OnlineEndpoint objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type OnlineEndpoint. ,
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: ARM resource ID of the compute if it exists. optional ,
Required: False ,
}
string ,
mirrorTraffic:
{
Description: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50. ,
Required: False ,
}
object ,
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 ,
publicNetworkAccess:
{
Description: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
]
,
}
,
}
OnlineEndpoints_Delete (new)
Description :  Delete Online Endpoint (asynchronous).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{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: Online 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 ,
}
,
]
,
}
,
}
OnlineEndpoints_Get (new)
Description :  Get Online Endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{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: Online Endpoint 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 ,
}
{
compute:
{
Description: ARM resource ID of the compute if it exists. optional ,
Required: False ,
}
string ,
mirrorTraffic:
{
Description: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50. ,
Required: False ,
}
object ,
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 ,
publicNetworkAccess:
{
Description: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
]
,
}
,
}
OnlineEndpoints_Update (new)
Description :  Update Online Endpoint (asynchronous).
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{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: Online Endpoint 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 ,
}
{
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 ,
}
{
compute:
{
Description: ARM resource ID of the compute if it exists. optional ,
Required: False ,
}
string ,
mirrorTraffic:
{
Description: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50. ,
Required: False ,
}
object ,
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 ,
publicNetworkAccess:
{
Description: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100. ,
Required: False ,
}
object ,
}
,
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 ,
}
,
]
,
}
,
}
OnlineEndpoints_CreateOrUpdate (new)
Description :  Create or update Online Endpoint (asynchronous).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{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: Online Endpoint 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 ,
}
{
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: ARM resource ID of the compute if it exists. optional ,
Required: False ,
}
string ,
mirrorTraffic:
{
Description: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50. ,
Required: False ,
}
object ,
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 ,
publicNetworkAccess:
{
Description: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100. ,
Required: False ,
}
object ,
}
,
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: ARM resource ID of the compute if it exists. optional ,
Required: False ,
}
string ,
mirrorTraffic:
{
Description: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50. ,
Required: False ,
}
object ,
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 ,
publicNetworkAccess:
{
Description: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100. ,
Required: False ,
}
object ,
}
,
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: ARM resource ID of the compute if it exists. optional ,
Required: False ,
}
string ,
mirrorTraffic:
{
Description: Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50. ,
Required: False ,
}
object ,
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 ,
publicNetworkAccess:
{
Description: Set to "Enabled" for endpoints that should allow public access when Private Link is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OnlineDeployments_Delete (new)
Description :  Delete Inference Endpoint Deployment (asynchronous).
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OnlineDeployments_GetLogs (new)
Description :  Polls an Endpoint operation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs
{
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 name and identifier for the endpoint. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The request containing parameters for retrieving logs. ,
Required: True ,
}
{
containerType:
{
Description: The type of container to retrieve logs from. ,
Enum:
{
StorageInitializer: No description available. ,
InferenceServer: No description available. ,
}
,
Required: False ,
}
enum ,
tail:
{
Description: The maximum number of lines to tail. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
content:
{
Description: The retrieved online deployment logs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/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 ,
endpointName:
{
Description: Inference endpoint name. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Inference Endpoint Deployment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}
,
]
,
}
,
}
OnlineEndpoints_ListKeys (new)
Description :  List EndpointAuthKeys for an Endpoint using Key-based authentication.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{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: Online 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 ,
}
,
]
,
}
,
}
OnlineEndpoints_RegenerateKeys (new)
Description :  Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
endpointName:
{
Description: Online Endpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: RegenerateKeys request . ,
Required: True ,
}
{
keyType:
{
Description: [Required] Specification for which type of key to generate. Primary or Secondary. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: True ,
}
enum ,
keyValue:
{
Description: The value the key is set to. ,
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 ,
}
,
]
,
}
,
}
OnlineEndpoints_GetToken (new)
Description :  Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
accessToken:
{
Description: Access token for endpoint authentication. ,
Required: False ,
}
string ,
expiryTimeUtc:
{
Description: Access token expiry time (UTC). ,
Format: int64 ,
Required: False ,
}
integer ,
refreshAfterTimeUtc:
{
Description: Refresh access token after time (UTC). ,
Format: int64 ,
Required: False ,
}
integer ,
tokenType:
{
Description: Access token type. ,
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 ,
}
,
]
,
}
,
}
Schedules_List (new)
Description :  List schedules in specified workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules
{
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: Status filter for schedule. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of Schedule objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type Schedule. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
action:
{
Description: [Required] Specifies the action of the schedule ,
Required: True ,
}
{
actionType:
{
Description: [Required] Specifies the action type of the schedule ,
Enum:
{
CreateJob: No description available. ,
InvokeBatchEndpoint: No description available. ,
CreateMonitor: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Display name of schedule. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Is the schedule enabled? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state for the schedule. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
trigger:
{
Description: [Required] Specifies the trigger details ,
Required: True ,
}
{
endTime:
{
Description: Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. Recommented format would be "2022-06-01T00:00:01" If not present, the schedule will run indefinitely ,
Required: False ,
}
string ,
startTime:
{
Description: Specifies start time of schedule in ISO 8601 format, but without a UTC offset. ,
Required: False ,
}
string ,
timeZone:
{
Description: Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 ,
Required: False ,
}
string ,
triggerType:
{
Description: [Required] ,
Enum:
{
Recurrence: No description available. ,
Cron: 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 ,
}
,
]
,
}
,
}
Schedules_Delete (new)
Description :  Delete schedule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{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: Schedule 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 ,
}
,
]
,
}
,
}
Schedules_Get (new)
Description :  Get schedule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{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: Schedule 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 ,
}
{
action:
{
Description: [Required] Specifies the action of the schedule ,
Required: True ,
}
{
actionType:
{
Description: [Required] Specifies the action type of the schedule ,
Enum:
{
CreateJob: No description available. ,
InvokeBatchEndpoint: No description available. ,
CreateMonitor: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Display name of schedule. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Is the schedule enabled? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state for the schedule. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
trigger:
{
Description: [Required] Specifies the trigger details ,
Required: True ,
}
{
endTime:
{
Description: Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. Recommented format would be "2022-06-01T00:00:01" If not present, the schedule will run indefinitely ,
Required: False ,
}
string ,
startTime:
{
Description: Specifies start time of schedule in ISO 8601 format, but without a UTC offset. ,
Required: False ,
}
string ,
timeZone:
{
Description: Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 ,
Required: False ,
}
string ,
triggerType:
{
Description: [Required] ,
Enum:
{
Recurrence: No description available. ,
Cron: 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 ,
}
,
]
,
}
,
}
Schedules_CreateOrUpdate (new)
Description :  Create or update schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/schedules/{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: Schedule name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Schedule definition. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
action:
{
Description: [Required] Specifies the action of the schedule ,
Required: True ,
}
{
actionType:
{
Description: [Required] Specifies the action type of the schedule ,
Enum:
{
CreateJob: No description available. ,
InvokeBatchEndpoint: No description available. ,
CreateMonitor: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Display name of schedule. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Is the schedule enabled? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state for the schedule. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
trigger:
{
Description: [Required] Specifies the trigger details ,
Required: True ,
}
{
endTime:
{
Description: Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. Recommented format would be "2022-06-01T00:00:01" If not present, the schedule will run indefinitely ,
Required: False ,
}
string ,
startTime:
{
Description: Specifies start time of schedule in ISO 8601 format, but without a UTC offset. ,
Required: False ,
}
string ,
timeZone:
{
Description: Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 ,
Required: False ,
}
string ,
triggerType:
{
Description: [Required] ,
Enum:
{
Recurrence: No description available. ,
Cron: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
action:
{
Description: [Required] Specifies the action of the schedule ,
Required: True ,
}
{
actionType:
{
Description: [Required] Specifies the action type of the schedule ,
Enum:
{
CreateJob: No description available. ,
InvokeBatchEndpoint: No description available. ,
CreateMonitor: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Display name of schedule. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Is the schedule enabled? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state for the schedule. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
trigger:
{
Description: [Required] Specifies the trigger details ,
Required: True ,
}
{
endTime:
{
Description: Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. Recommented format would be "2022-06-01T00:00:01" If not present, the schedule will run indefinitely ,
Required: False ,
}
string ,
startTime:
{
Description: Specifies start time of schedule in ISO 8601 format, but without a UTC offset. ,
Required: False ,
}
string ,
timeZone:
{
Description: Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 ,
Required: False ,
}
string ,
triggerType:
{
Description: [Required] ,
Enum:
{
Recurrence: No description available. ,
Cron: 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 ,
}
{
action:
{
Description: [Required] Specifies the action of the schedule ,
Required: True ,
}
{
actionType:
{
Description: [Required] Specifies the action type of the schedule ,
Enum:
{
CreateJob: No description available. ,
InvokeBatchEndpoint: No description available. ,
CreateMonitor: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
displayName:
{
Description: Display name of schedule. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Is the schedule enabled? ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: Provisioning state for the schedule. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
trigger:
{
Description: [Required] Specifies the trigger details ,
Required: True ,
}
{
endTime:
{
Description: Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. Recommented format would be "2022-06-01T00:00:01" If not present, the schedule will run indefinitely ,
Required: False ,
}
string ,
startTime:
{
Description: Specifies start time of schedule in ISO 8601 format, but without a UTC offset. ,
Required: False ,
}
string ,
timeZone:
{
Description: Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 ,
Required: False ,
}
string ,
triggerType:
{
Description: [Required] ,
Enum:
{
Recurrence: No description available. ,
Cron: 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 ,
}
,
]
,
}
,
}
ServerlessEndpoints_List (new)
Description :  List Serverless Endpoints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints
{
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 ServerlessEndpoint objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type ServerlessEndpoint. ,
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] Specifies the authentication mode for the Serverless endpoint. ,
Enum:
{
Key: No description available. ,
AAD: No description available. ,
KeyAndAAD: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafety:
{
Description: Specifies the content safety options. If omitted, the default content safety settings will be configured ,
Required: False ,
}
{
contentSafetyLevel:
{
Description: [Required] Specifies the current safety level for content safety. ,
Enum:
{
Blocking: No description available. ,
Deferred: No description available. ,
}
,
Required: False ,
}
enum ,
contentSafetyStatus:
{
Description: [Required] Specifies the status of content safety. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpointState:
{
Description: The current state of the ServerlessEndpoint. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Suspending: No description available. ,
Reinstating: No description available. ,
Online: No description available. ,
Suspended: No description available. ,
CreationFailed: No description available. ,
DeletionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
inferenceEndpoint:
{
Description: The inference uri to target when making requests against the serverless endpoint ,
Required: False ,
}
{
headers:
{
Description: Specifies any required headers to target this serverless endpoint. ,
Required: False ,
}
object ,
uri:
{
Description: [Required] The inference uri to target when making requests against the Serverless Endpoint. ,
Format: uri ,
Required: True ,
}
string ,
}
,
marketplaceSubscriptionId:
{
Description: The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. ,
Required: False ,
}
string ,
modelSettings:
{
Description: The model settings (model id) for the model being serviced on the ServerlessEndpoint. ,
Required: False ,
}
{
modelId:
{
Description: The unique model identifier that this ServerlessEndpoint should provision. ,
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 ,
}
,
]
,
}
,
}
ServerlessEndpoints_Delete (new)
Description :  Delete Serverless Endpoint (asynchronous).
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{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: Serverless Endpoint 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 ,
}
,
]
,
}
,
}
ServerlessEndpoints_Get (new)
Description :  Get Serverless Endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{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: Serverless Endpoint 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] Specifies the authentication mode for the Serverless endpoint. ,
Enum:
{
Key: No description available. ,
AAD: No description available. ,
KeyAndAAD: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafety:
{
Description: Specifies the content safety options. If omitted, the default content safety settings will be configured ,
Required: False ,
}
{
contentSafetyLevel:
{
Description: [Required] Specifies the current safety level for content safety. ,
Enum:
{
Blocking: No description available. ,
Deferred: No description available. ,
}
,
Required: False ,
}
enum ,
contentSafetyStatus:
{
Description: [Required] Specifies the status of content safety. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpointState:
{
Description: The current state of the ServerlessEndpoint. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Suspending: No description available. ,
Reinstating: No description available. ,
Online: No description available. ,
Suspended: No description available. ,
CreationFailed: No description available. ,
DeletionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
inferenceEndpoint:
{
Description: The inference uri to target when making requests against the serverless endpoint ,
Required: False ,
}
{
headers:
{
Description: Specifies any required headers to target this serverless endpoint. ,
Required: False ,
}
object ,
uri:
{
Description: [Required] The inference uri to target when making requests against the Serverless Endpoint. ,
Format: uri ,
Required: True ,
}
string ,
}
,
marketplaceSubscriptionId:
{
Description: The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. ,
Required: False ,
}
string ,
modelSettings:
{
Description: The model settings (model id) for the model being serviced on the ServerlessEndpoint. ,
Required: False ,
}
{
modelId:
{
Description: The unique model identifier that this ServerlessEndpoint should provision. ,
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 ,
}
,
]
,
}
,
}
ServerlessEndpoints_Update (new)
Description :  Update Serverless Endpoint (asynchronous).
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{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: Serverless Endpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Serverless Endpoint 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 ,
}
{
authMode:
{
Description: [Required] Specifies the authentication mode for the Serverless endpoint. ,
Enum:
{
Key: No description available. ,
AAD: No description available. ,
KeyAndAAD: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafety:
{
Description: Specifies the content safety options. If omitted, the default content safety settings will be configured ,
Required: False ,
}
{
contentSafetyLevel:
{
Description: [Required] Specifies the current safety level for content safety. ,
Enum:
{
Blocking: No description available. ,
Deferred: No description available. ,
}
,
Required: False ,
}
enum ,
contentSafetyStatus:
{
Description: [Required] Specifies the status of content safety. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpointState:
{
Description: The current state of the ServerlessEndpoint. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Suspending: No description available. ,
Reinstating: No description available. ,
Online: No description available. ,
Suspended: No description available. ,
CreationFailed: No description available. ,
DeletionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
inferenceEndpoint:
{
Description: The inference uri to target when making requests against the serverless endpoint ,
Required: False ,
}
{
headers:
{
Description: Specifies any required headers to target this serverless endpoint. ,
Required: False ,
}
object ,
uri:
{
Description: [Required] The inference uri to target when making requests against the Serverless Endpoint. ,
Format: uri ,
Required: True ,
}
string ,
}
,
marketplaceSubscriptionId:
{
Description: The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. ,
Required: False ,
}
string ,
modelSettings:
{
Description: The model settings (model id) for the model being serviced on the ServerlessEndpoint. ,
Required: False ,
}
{
modelId:
{
Description: The unique model identifier that this ServerlessEndpoint should provision. ,
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 ,
}
,
]
,
}
,
}
ServerlessEndpoints_CreateOrUpdate (new)
Description :  Create or update Serverless Endpoint (asynchronous).
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{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: Serverless Endpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Serverless Endpoint entity to apply during operation. ,
Required: True ,
}
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
authMode:
{
Description: [Required] Specifies the authentication mode for the Serverless endpoint. ,
Enum:
{
Key: No description available. ,
AAD: No description available. ,
KeyAndAAD: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafety:
{
Description: Specifies the content safety options. If omitted, the default content safety settings will be configured ,
Required: False ,
}
{
contentSafetyLevel:
{
Description: [Required] Specifies the current safety level for content safety. ,
Enum:
{
Blocking: No description available. ,
Deferred: No description available. ,
}
,
Required: False ,
}
enum ,
contentSafetyStatus:
{
Description: [Required] Specifies the status of content safety. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpointState:
{
Description: The current state of the ServerlessEndpoint. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Suspending: No description available. ,
Reinstating: No description available. ,
Online: No description available. ,
Suspended: No description available. ,
CreationFailed: No description available. ,
DeletionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
inferenceEndpoint:
{
Description: The inference uri to target when making requests against the serverless endpoint ,
Required: False ,
}
{
headers:
{
Description: Specifies any required headers to target this serverless endpoint. ,
Required: False ,
}
object ,
uri:
{
Description: [Required] The inference uri to target when making requests against the Serverless Endpoint. ,
Format: uri ,
Required: True ,
}
string ,
}
,
marketplaceSubscriptionId:
{
Description: The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. ,
Required: False ,
}
string ,
modelSettings:
{
Description: The model settings (model id) for the model being serviced on the ServerlessEndpoint. ,
Required: False ,
}
{
modelId:
{
Description: The unique model identifier that this ServerlessEndpoint should provision. ,
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 ,
}
{
authMode:
{
Description: [Required] Specifies the authentication mode for the Serverless endpoint. ,
Enum:
{
Key: No description available. ,
AAD: No description available. ,
KeyAndAAD: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafety:
{
Description: Specifies the content safety options. If omitted, the default content safety settings will be configured ,
Required: False ,
}
{
contentSafetyLevel:
{
Description: [Required] Specifies the current safety level for content safety. ,
Enum:
{
Blocking: No description available. ,
Deferred: No description available. ,
}
,
Required: False ,
}
enum ,
contentSafetyStatus:
{
Description: [Required] Specifies the status of content safety. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpointState:
{
Description: The current state of the ServerlessEndpoint. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Suspending: No description available. ,
Reinstating: No description available. ,
Online: No description available. ,
Suspended: No description available. ,
CreationFailed: No description available. ,
DeletionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
inferenceEndpoint:
{
Description: The inference uri to target when making requests against the serverless endpoint ,
Required: False ,
}
{
headers:
{
Description: Specifies any required headers to target this serverless endpoint. ,
Required: False ,
}
object ,
uri:
{
Description: [Required] The inference uri to target when making requests against the Serverless Endpoint. ,
Format: uri ,
Required: True ,
}
string ,
}
,
marketplaceSubscriptionId:
{
Description: The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. ,
Required: False ,
}
string ,
modelSettings:
{
Description: The model settings (model id) for the model being serviced on the ServerlessEndpoint. ,
Required: False ,
}
{
modelId:
{
Description: The unique model identifier that this ServerlessEndpoint should provision. ,
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 ,
}
{
authMode:
{
Description: [Required] Specifies the authentication mode for the Serverless endpoint. ,
Enum:
{
Key: No description available. ,
AAD: No description available. ,
KeyAndAAD: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafety:
{
Description: Specifies the content safety options. If omitted, the default content safety settings will be configured ,
Required: False ,
}
{
contentSafetyLevel:
{
Description: [Required] Specifies the current safety level for content safety. ,
Enum:
{
Blocking: No description available. ,
Deferred: No description available. ,
}
,
Required: False ,
}
enum ,
contentSafetyStatus:
{
Description: [Required] Specifies the status of content safety. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpointState:
{
Description: The current state of the ServerlessEndpoint. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Suspending: No description available. ,
Reinstating: No description available. ,
Online: No description available. ,
Suspended: No description available. ,
CreationFailed: No description available. ,
DeletionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
inferenceEndpoint:
{
Description: The inference uri to target when making requests against the serverless endpoint ,
Required: False ,
}
{
headers:
{
Description: Specifies any required headers to target this serverless endpoint. ,
Required: False ,
}
object ,
uri:
{
Description: [Required] The inference uri to target when making requests against the Serverless Endpoint. ,
Format: uri ,
Required: True ,
}
string ,
}
,
marketplaceSubscriptionId:
{
Description: The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. ,
Required: False ,
}
string ,
modelSettings:
{
Description: The model settings (model id) for the model being serviced on the ServerlessEndpoint. ,
Required: False ,
}
{
modelId:
{
Description: The unique model identifier that this ServerlessEndpoint should provision. ,
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 ,
}
,
]
,
}
,
}
ServerlessEndpoints_ListKeys (new)
Description :  List EndpointAuthKeys for an Endpoint using Key-based authentication.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/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 ,
name:
{
Description: Serverless 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 ,
}
,
]
,
}
,
}
ServerlessEndpoints_RegenerateKeys (new)
Description :  Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}/regenerateKeys
{
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: Serverless Endpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: RegenerateKeys request . ,
Required: True ,
}
{
keyType:
{
Description: [Required] Specification for which type of key to generate. Primary or Secondary. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: True ,
}
enum ,
keyValue:
{
Description: The value the key is set to. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
primaryKey:
{
Description: The primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary key. ,
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 ,
}
,
]
,
}
,
}
Registries_ListBySubscription (new)
Description :  List registries by subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/registries
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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)

{
nextLink:
{
Description: The link to the next page of Registry objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type Registry. ,
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 ,
}
{
discoveryUrl:
{
Description: Discovery URL for the Registry ,
Required: False ,
}
string ,
intellectualPropertyPublisher:
{
Description: IntellectualPropertyPublisher for the registry ,
Required: False ,
}
string ,
managedResourceGroup:
{
Description: ResourceId of the managed RG if the registry has system created resources ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
managedResourceGroupSettings:
{
Description: Managed resource group specific settings ,
Required: False ,
}
{
assignedIdentities:
{
Description: List of assigned identities for the managed resource group ,
Required: False ,
}
[
{
principalId:
{
Description: Identity principal Id ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
}
,
mlFlowRegistryUri:
{
Description: MLFlow Registry URI for the Registry ,
Required: False ,
}
string ,
registryPrivateEndpointConnections:
{
Description: Private endpoint connections info used for pending connections in private link portal ,
Required: False ,
}
[
{
id:
{
Description: This is the private endpoint connection name created on SRP Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName} ,
Required: False ,
}
string ,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private Endpoint Connection ,
Required: False ,
}
{
groupIds:
{
Description: The group ids ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The PE network resource that is linked to this PE connection. ,
Required: False ,
}
{
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
registryPrivateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: One of null, "Succeeded", "Provisioning", "Failed". While not approved, it's null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Is the Registry accessible from the internet? Possible values: "Enabled" or "Disabled" ,
Required: False ,
}
string ,
regionDetails:
{
Description: Details of each region the registry is in ,
Required: False ,
}
[
{
acrDetails:
{
Description: List of ACR accounts ,
Required: False ,
}
[
{
systemCreatedAcrAccount:
{
Description: Details of system created ACR account to be used for the Registry ,
Required: False ,
}
{
acrAccountName:
{
Description: Name of the ACR account ,
Required: False ,
}
string ,
acrAccountSku:
{
Description: SKU of the ACR account ,
Required: False ,
}
string ,
armResourceId:
{
Description: This is populated once the ACR account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
userCreatedAcrAccount:
{
Description: Details of user created ACR account to be used for the Registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
location:
{
Description: The location where the registry exists ,
Required: False ,
}
string ,
storageAccountDetails:
{
Description: List of storage accounts ,
Required: False ,
}
[
{
systemCreatedStorageAccount:
{
Description: Details of system created storage account to be used for the registry ,
Required: False ,
}
{
allowBlobPublicAccess:
{
Description: Public blob access allowed ,
Required: False ,
}
boolean ,
armResourceId:
{
Description: This is populated once the storage account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
storageAccountHnsEnabled:
{
Description: HNS enabled for storage account ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: Name of the storage account ,
Required: False ,
}
string ,
storageAccountType:
{
Description: Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS" ,
Required: False ,
}
string ,
}
,
userCreatedStorageAccount:
{
Description: Details of user created storage account to be used for the registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
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 ,
}
,
}
,
]
,
}
Registries_List (new)
Description :  List registries
Reference :  Link ¶

⚼ Request

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

{
nextLink:
{
Description: The link to the next page of Registry objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type Registry. ,
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 ,
}
{
discoveryUrl:
{
Description: Discovery URL for the Registry ,
Required: False ,
}
string ,
intellectualPropertyPublisher:
{
Description: IntellectualPropertyPublisher for the registry ,
Required: False ,
}
string ,
managedResourceGroup:
{
Description: ResourceId of the managed RG if the registry has system created resources ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
managedResourceGroupSettings:
{
Description: Managed resource group specific settings ,
Required: False ,
}
{
assignedIdentities:
{
Description: List of assigned identities for the managed resource group ,
Required: False ,
}
[
{
principalId:
{
Description: Identity principal Id ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
}
,
mlFlowRegistryUri:
{
Description: MLFlow Registry URI for the Registry ,
Required: False ,
}
string ,
registryPrivateEndpointConnections:
{
Description: Private endpoint connections info used for pending connections in private link portal ,
Required: False ,
}
[
{
id:
{
Description: This is the private endpoint connection name created on SRP Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName} ,
Required: False ,
}
string ,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private Endpoint Connection ,
Required: False ,
}
{
groupIds:
{
Description: The group ids ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The PE network resource that is linked to this PE connection. ,
Required: False ,
}
{
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
registryPrivateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: One of null, "Succeeded", "Provisioning", "Failed". While not approved, it's null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Is the Registry accessible from the internet? Possible values: "Enabled" or "Disabled" ,
Required: False ,
}
string ,
regionDetails:
{
Description: Details of each region the registry is in ,
Required: False ,
}
[
{
acrDetails:
{
Description: List of ACR accounts ,
Required: False ,
}
[
{
systemCreatedAcrAccount:
{
Description: Details of system created ACR account to be used for the Registry ,
Required: False ,
}
{
acrAccountName:
{
Description: Name of the ACR account ,
Required: False ,
}
string ,
acrAccountSku:
{
Description: SKU of the ACR account ,
Required: False ,
}
string ,
armResourceId:
{
Description: This is populated once the ACR account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
userCreatedAcrAccount:
{
Description: Details of user created ACR account to be used for the Registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
location:
{
Description: The location where the registry exists ,
Required: False ,
}
string ,
storageAccountDetails:
{
Description: List of storage accounts ,
Required: False ,
}
[
{
systemCreatedStorageAccount:
{
Description: Details of system created storage account to be used for the registry ,
Required: False ,
}
{
allowBlobPublicAccess:
{
Description: Public blob access allowed ,
Required: False ,
}
boolean ,
armResourceId:
{
Description: This is populated once the storage account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
storageAccountHnsEnabled:
{
Description: HNS enabled for storage account ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: Name of the storage account ,
Required: False ,
}
string ,
storageAccountType:
{
Description: Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS" ,
Required: False ,
}
string ,
}
,
userCreatedStorageAccount:
{
Description: Details of user created storage account to be used for the registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
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 ,
}
,
}
,
]
,
}
Registries_Delete (new)
Description :  Delete registry
Reference :  Link ¶

⚼ Request

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

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

{}

⚐ Response (204)

{}
Registries_Get (new)
Description :  Get registry
Reference :  Link ¶

⚼ Request

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

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

{
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 ,
}
{
discoveryUrl:
{
Description: Discovery URL for the Registry ,
Required: False ,
}
string ,
intellectualPropertyPublisher:
{
Description: IntellectualPropertyPublisher for the registry ,
Required: False ,
}
string ,
managedResourceGroup:
{
Description: ResourceId of the managed RG if the registry has system created resources ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
managedResourceGroupSettings:
{
Description: Managed resource group specific settings ,
Required: False ,
}
{
assignedIdentities:
{
Description: List of assigned identities for the managed resource group ,
Required: False ,
}
[
{
principalId:
{
Description: Identity principal Id ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
}
,
mlFlowRegistryUri:
{
Description: MLFlow Registry URI for the Registry ,
Required: False ,
}
string ,
registryPrivateEndpointConnections:
{
Description: Private endpoint connections info used for pending connections in private link portal ,
Required: False ,
}
[
{
id:
{
Description: This is the private endpoint connection name created on SRP Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName} ,
Required: False ,
}
string ,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private Endpoint Connection ,
Required: False ,
}
{
groupIds:
{
Description: The group ids ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The PE network resource that is linked to this PE connection. ,
Required: False ,
}
{
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
registryPrivateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: One of null, "Succeeded", "Provisioning", "Failed". While not approved, it's null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Is the Registry accessible from the internet? Possible values: "Enabled" or "Disabled" ,
Required: False ,
}
string ,
regionDetails:
{
Description: Details of each region the registry is in ,
Required: False ,
}
[
{
acrDetails:
{
Description: List of ACR accounts ,
Required: False ,
}
[
{
systemCreatedAcrAccount:
{
Description: Details of system created ACR account to be used for the Registry ,
Required: False ,
}
{
acrAccountName:
{
Description: Name of the ACR account ,
Required: False ,
}
string ,
acrAccountSku:
{
Description: SKU of the ACR account ,
Required: False ,
}
string ,
armResourceId:
{
Description: This is populated once the ACR account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
userCreatedAcrAccount:
{
Description: Details of user created ACR account to be used for the Registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
location:
{
Description: The location where the registry exists ,
Required: False ,
}
string ,
storageAccountDetails:
{
Description: List of storage accounts ,
Required: False ,
}
[
{
systemCreatedStorageAccount:
{
Description: Details of system created storage account to be used for the registry ,
Required: False ,
}
{
allowBlobPublicAccess:
{
Description: Public blob access allowed ,
Required: False ,
}
boolean ,
armResourceId:
{
Description: This is populated once the storage account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
storageAccountHnsEnabled:
{
Description: HNS enabled for storage account ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: Name of the storage account ,
Required: False ,
}
string ,
storageAccountType:
{
Description: Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS" ,
Required: False ,
}
string ,
}
,
userCreatedStorageAccount:
{
Description: Details of user created storage account to be used for the registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
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 ,
}
,
}
Registries_Update (new)
Description :  Update tags
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}
{
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 ,
body:
{
Description: Details required to create the registry. ,
Required: True ,
}
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
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 ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

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

{
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 ,
}
{
discoveryUrl:
{
Description: Discovery URL for the Registry ,
Required: False ,
}
string ,
intellectualPropertyPublisher:
{
Description: IntellectualPropertyPublisher for the registry ,
Required: False ,
}
string ,
managedResourceGroup:
{
Description: ResourceId of the managed RG if the registry has system created resources ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
managedResourceGroupSettings:
{
Description: Managed resource group specific settings ,
Required: False ,
}
{
assignedIdentities:
{
Description: List of assigned identities for the managed resource group ,
Required: False ,
}
[
{
principalId:
{
Description: Identity principal Id ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
}
,
mlFlowRegistryUri:
{
Description: MLFlow Registry URI for the Registry ,
Required: False ,
}
string ,
registryPrivateEndpointConnections:
{
Description: Private endpoint connections info used for pending connections in private link portal ,
Required: False ,
}
[
{
id:
{
Description: This is the private endpoint connection name created on SRP Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName} ,
Required: False ,
}
string ,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private Endpoint Connection ,
Required: False ,
}
{
groupIds:
{
Description: The group ids ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The PE network resource that is linked to this PE connection. ,
Required: False ,
}
{
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
registryPrivateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: One of null, "Succeeded", "Provisioning", "Failed". While not approved, it's null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Is the Registry accessible from the internet? Possible values: "Enabled" or "Disabled" ,
Required: False ,
}
string ,
regionDetails:
{
Description: Details of each region the registry is in ,
Required: False ,
}
[
{
acrDetails:
{
Description: List of ACR accounts ,
Required: False ,
}
[
{
systemCreatedAcrAccount:
{
Description: Details of system created ACR account to be used for the Registry ,
Required: False ,
}
{
acrAccountName:
{
Description: Name of the ACR account ,
Required: False ,
}
string ,
acrAccountSku:
{
Description: SKU of the ACR account ,
Required: False ,
}
string ,
armResourceId:
{
Description: This is populated once the ACR account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
userCreatedAcrAccount:
{
Description: Details of user created ACR account to be used for the Registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
location:
{
Description: The location where the registry exists ,
Required: False ,
}
string ,
storageAccountDetails:
{
Description: List of storage accounts ,
Required: False ,
}
[
{
systemCreatedStorageAccount:
{
Description: Details of system created storage account to be used for the registry ,
Required: False ,
}
{
allowBlobPublicAccess:
{
Description: Public blob access allowed ,
Required: False ,
}
boolean ,
armResourceId:
{
Description: This is populated once the storage account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
storageAccountHnsEnabled:
{
Description: HNS enabled for storage account ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: Name of the storage account ,
Required: False ,
}
string ,
storageAccountType:
{
Description: Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS" ,
Required: False ,
}
string ,
}
,
userCreatedStorageAccount:
{
Description: Details of user created storage account to be used for the registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
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 ,
}
,
}
Registries_CreateOrUpdate (new)
Description :  Create or update registry
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}
{
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 ,
body:
{
Description: Details required to create the registry. ,
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 ,
}
{
discoveryUrl:
{
Description: Discovery URL for the Registry ,
Required: False ,
}
string ,
intellectualPropertyPublisher:
{
Description: IntellectualPropertyPublisher for the registry ,
Required: False ,
}
string ,
managedResourceGroup:
{
Description: ResourceId of the managed RG if the registry has system created resources ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
managedResourceGroupSettings:
{
Description: Managed resource group specific settings ,
Required: False ,
}
{
assignedIdentities:
{
Description: List of assigned identities for the managed resource group ,
Required: False ,
}
[
{
principalId:
{
Description: Identity principal Id ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
}
,
mlFlowRegistryUri:
{
Description: MLFlow Registry URI for the Registry ,
Required: False ,
}
string ,
registryPrivateEndpointConnections:
{
Description: Private endpoint connections info used for pending connections in private link portal ,
Required: False ,
}
[
{
id:
{
Description: This is the private endpoint connection name created on SRP Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName} ,
Required: False ,
}
string ,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private Endpoint Connection ,
Required: False ,
}
{
groupIds:
{
Description: The group ids ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The PE network resource that is linked to this PE connection. ,
Required: False ,
}
{
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
registryPrivateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: One of null, "Succeeded", "Provisioning", "Failed". While not approved, it's null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Is the Registry accessible from the internet? Possible values: "Enabled" or "Disabled" ,
Required: False ,
}
string ,
regionDetails:
{
Description: Details of each region the registry is in ,
Required: False ,
}
[
{
acrDetails:
{
Description: List of ACR accounts ,
Required: False ,
}
[
{
systemCreatedAcrAccount:
{
Description: Details of system created ACR account to be used for the Registry ,
Required: False ,
}
{
acrAccountName:
{
Description: Name of the ACR account ,
Required: False ,
}
string ,
acrAccountSku:
{
Description: SKU of the ACR account ,
Required: False ,
}
string ,
armResourceId:
{
Description: This is populated once the ACR account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
userCreatedAcrAccount:
{
Description: Details of user created ACR account to be used for the Registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
location:
{
Description: The location where the registry exists ,
Required: False ,
}
string ,
storageAccountDetails:
{
Description: List of storage accounts ,
Required: False ,
}
[
{
systemCreatedStorageAccount:
{
Description: Details of system created storage account to be used for the registry ,
Required: False ,
}
{
allowBlobPublicAccess:
{
Description: Public blob access allowed ,
Required: False ,
}
boolean ,
armResourceId:
{
Description: This is populated once the storage account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
storageAccountHnsEnabled:
{
Description: HNS enabled for storage account ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: Name of the storage account ,
Required: False ,
}
string ,
storageAccountType:
{
Description: Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS" ,
Required: False ,
}
string ,
}
,
userCreatedStorageAccount:
{
Description: Details of user created storage account to be used for the registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
{
discoveryUrl:
{
Description: Discovery URL for the Registry ,
Required: False ,
}
string ,
intellectualPropertyPublisher:
{
Description: IntellectualPropertyPublisher for the registry ,
Required: False ,
}
string ,
managedResourceGroup:
{
Description: ResourceId of the managed RG if the registry has system created resources ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
managedResourceGroupSettings:
{
Description: Managed resource group specific settings ,
Required: False ,
}
{
assignedIdentities:
{
Description: List of assigned identities for the managed resource group ,
Required: False ,
}
[
{
principalId:
{
Description: Identity principal Id ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
}
,
mlFlowRegistryUri:
{
Description: MLFlow Registry URI for the Registry ,
Required: False ,
}
string ,
registryPrivateEndpointConnections:
{
Description: Private endpoint connections info used for pending connections in private link portal ,
Required: False ,
}
[
{
id:
{
Description: This is the private endpoint connection name created on SRP Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName} ,
Required: False ,
}
string ,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private Endpoint Connection ,
Required: False ,
}
{
groupIds:
{
Description: The group ids ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The PE network resource that is linked to this PE connection. ,
Required: False ,
}
{
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
registryPrivateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: One of null, "Succeeded", "Provisioning", "Failed". While not approved, it's null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Is the Registry accessible from the internet? Possible values: "Enabled" or "Disabled" ,
Required: False ,
}
string ,
regionDetails:
{
Description: Details of each region the registry is in ,
Required: False ,
}
[
{
acrDetails:
{
Description: List of ACR accounts ,
Required: False ,
}
[
{
systemCreatedAcrAccount:
{
Description: Details of system created ACR account to be used for the Registry ,
Required: False ,
}
{
acrAccountName:
{
Description: Name of the ACR account ,
Required: False ,
}
string ,
acrAccountSku:
{
Description: SKU of the ACR account ,
Required: False ,
}
string ,
armResourceId:
{
Description: This is populated once the ACR account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
userCreatedAcrAccount:
{
Description: Details of user created ACR account to be used for the Registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
location:
{
Description: The location where the registry exists ,
Required: False ,
}
string ,
storageAccountDetails:
{
Description: List of storage accounts ,
Required: False ,
}
[
{
systemCreatedStorageAccount:
{
Description: Details of system created storage account to be used for the registry ,
Required: False ,
}
{
allowBlobPublicAccess:
{
Description: Public blob access allowed ,
Required: False ,
}
boolean ,
armResourceId:
{
Description: This is populated once the storage account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
storageAccountHnsEnabled:
{
Description: HNS enabled for storage account ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: Name of the storage account ,
Required: False ,
}
string ,
storageAccountType:
{
Description: Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS" ,
Required: False ,
}
string ,
}
,
userCreatedStorageAccount:
{
Description: Details of user created storage account to be used for the registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
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)

{
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 ,
}
{
discoveryUrl:
{
Description: Discovery URL for the Registry ,
Required: False ,
}
string ,
intellectualPropertyPublisher:
{
Description: IntellectualPropertyPublisher for the registry ,
Required: False ,
}
string ,
managedResourceGroup:
{
Description: ResourceId of the managed RG if the registry has system created resources ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
managedResourceGroupSettings:
{
Description: Managed resource group specific settings ,
Required: False ,
}
{
assignedIdentities:
{
Description: List of assigned identities for the managed resource group ,
Required: False ,
}
[
{
principalId:
{
Description: Identity principal Id ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
}
,
mlFlowRegistryUri:
{
Description: MLFlow Registry URI for the Registry ,
Required: False ,
}
string ,
registryPrivateEndpointConnections:
{
Description: Private endpoint connections info used for pending connections in private link portal ,
Required: False ,
}
[
{
id:
{
Description: This is the private endpoint connection name created on SRP Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName} ,
Required: False ,
}
string ,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private Endpoint Connection ,
Required: False ,
}
{
groupIds:
{
Description: The group ids ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The PE network resource that is linked to this PE connection. ,
Required: False ,
}
{
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
registryPrivateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: One of null, "Succeeded", "Provisioning", "Failed". While not approved, it's null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Is the Registry accessible from the internet? Possible values: "Enabled" or "Disabled" ,
Required: False ,
}
string ,
regionDetails:
{
Description: Details of each region the registry is in ,
Required: False ,
}
[
{
acrDetails:
{
Description: List of ACR accounts ,
Required: False ,
}
[
{
systemCreatedAcrAccount:
{
Description: Details of system created ACR account to be used for the Registry ,
Required: False ,
}
{
acrAccountName:
{
Description: Name of the ACR account ,
Required: False ,
}
string ,
acrAccountSku:
{
Description: SKU of the ACR account ,
Required: False ,
}
string ,
armResourceId:
{
Description: This is populated once the ACR account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
userCreatedAcrAccount:
{
Description: Details of user created ACR account to be used for the Registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
location:
{
Description: The location where the registry exists ,
Required: False ,
}
string ,
storageAccountDetails:
{
Description: List of storage accounts ,
Required: False ,
}
[
{
systemCreatedStorageAccount:
{
Description: Details of system created storage account to be used for the registry ,
Required: False ,
}
{
allowBlobPublicAccess:
{
Description: Public blob access allowed ,
Required: False ,
}
boolean ,
armResourceId:
{
Description: This is populated once the storage account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
storageAccountHnsEnabled:
{
Description: HNS enabled for storage account ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: Name of the storage account ,
Required: False ,
}
string ,
storageAccountType:
{
Description: Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS" ,
Required: False ,
}
string ,
}
,
userCreatedStorageAccount:
{
Description: Details of user created storage account to be used for the registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
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 ,
}
,
}
Registries_RemoveRegions (new)
Description :  Remove regions from registry
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/removeRegions
{
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 ,
body:
{
Description: Details required to create the registry. ,
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 ,
}
{
discoveryUrl:
{
Description: Discovery URL for the Registry ,
Required: False ,
}
string ,
intellectualPropertyPublisher:
{
Description: IntellectualPropertyPublisher for the registry ,
Required: False ,
}
string ,
managedResourceGroup:
{
Description: ResourceId of the managed RG if the registry has system created resources ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
managedResourceGroupSettings:
{
Description: Managed resource group specific settings ,
Required: False ,
}
{
assignedIdentities:
{
Description: List of assigned identities for the managed resource group ,
Required: False ,
}
[
{
principalId:
{
Description: Identity principal Id ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
}
,
mlFlowRegistryUri:
{
Description: MLFlow Registry URI for the Registry ,
Required: False ,
}
string ,
registryPrivateEndpointConnections:
{
Description: Private endpoint connections info used for pending connections in private link portal ,
Required: False ,
}
[
{
id:
{
Description: This is the private endpoint connection name created on SRP Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName} ,
Required: False ,
}
string ,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private Endpoint Connection ,
Required: False ,
}
{
groupIds:
{
Description: The group ids ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The PE network resource that is linked to this PE connection. ,
Required: False ,
}
{
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
registryPrivateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: One of null, "Succeeded", "Provisioning", "Failed". While not approved, it's null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Is the Registry accessible from the internet? Possible values: "Enabled" or "Disabled" ,
Required: False ,
}
string ,
regionDetails:
{
Description: Details of each region the registry is in ,
Required: False ,
}
[
{
acrDetails:
{
Description: List of ACR accounts ,
Required: False ,
}
[
{
systemCreatedAcrAccount:
{
Description: Details of system created ACR account to be used for the Registry ,
Required: False ,
}
{
acrAccountName:
{
Description: Name of the ACR account ,
Required: False ,
}
string ,
acrAccountSku:
{
Description: SKU of the ACR account ,
Required: False ,
}
string ,
armResourceId:
{
Description: This is populated once the ACR account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
userCreatedAcrAccount:
{
Description: Details of user created ACR account to be used for the Registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
location:
{
Description: The location where the registry exists ,
Required: False ,
}
string ,
storageAccountDetails:
{
Description: List of storage accounts ,
Required: False ,
}
[
{
systemCreatedStorageAccount:
{
Description: Details of system created storage account to be used for the registry ,
Required: False ,
}
{
allowBlobPublicAccess:
{
Description: Public blob access allowed ,
Required: False ,
}
boolean ,
armResourceId:
{
Description: This is populated once the storage account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
storageAccountHnsEnabled:
{
Description: HNS enabled for storage account ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: Name of the storage account ,
Required: False ,
}
string ,
storageAccountType:
{
Description: Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS" ,
Required: False ,
}
string ,
}
,
userCreatedStorageAccount:
{
Description: Details of user created storage account to be used for the registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
{
discoveryUrl:
{
Description: Discovery URL for the Registry ,
Required: False ,
}
string ,
intellectualPropertyPublisher:
{
Description: IntellectualPropertyPublisher for the registry ,
Required: False ,
}
string ,
managedResourceGroup:
{
Description: ResourceId of the managed RG if the registry has system created resources ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
managedResourceGroupSettings:
{
Description: Managed resource group specific settings ,
Required: False ,
}
{
assignedIdentities:
{
Description: List of assigned identities for the managed resource group ,
Required: False ,
}
[
{
principalId:
{
Description: Identity principal Id ,
Format: uuid ,
Required: False ,
}
string ,
}
,
]
,
}
,
mlFlowRegistryUri:
{
Description: MLFlow Registry URI for the Registry ,
Required: False ,
}
string ,
registryPrivateEndpointConnections:
{
Description: Private endpoint connections info used for pending connections in private link portal ,
Required: False ,
}
[
{
id:
{
Description: This is the private endpoint connection name created on SRP Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName} ,
Required: False ,
}
string ,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the Private Endpoint Connection ,
Required: False ,
}
{
groupIds:
{
Description: The group ids ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The PE network resource that is linked to this PE connection. ,
Required: False ,
}
{
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
registryPrivateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: One of null, "Succeeded", "Provisioning", "Failed". While not approved, it's null. ,
Required: False ,
}
string ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Is the Registry accessible from the internet? Possible values: "Enabled" or "Disabled" ,
Required: False ,
}
string ,
regionDetails:
{
Description: Details of each region the registry is in ,
Required: False ,
}
[
{
acrDetails:
{
Description: List of ACR accounts ,
Required: False ,
}
[
{
systemCreatedAcrAccount:
{
Description: Details of system created ACR account to be used for the Registry ,
Required: False ,
}
{
acrAccountName:
{
Description: Name of the ACR account ,
Required: False ,
}
string ,
acrAccountSku:
{
Description: SKU of the ACR account ,
Required: False ,
}
string ,
armResourceId:
{
Description: This is populated once the ACR account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
userCreatedAcrAccount:
{
Description: Details of user created ACR account to be used for the Registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
location:
{
Description: The location where the registry exists ,
Required: False ,
}
string ,
storageAccountDetails:
{
Description: List of storage accounts ,
Required: False ,
}
[
{
systemCreatedStorageAccount:
{
Description: Details of system created storage account to be used for the registry ,
Required: False ,
}
{
allowBlobPublicAccess:
{
Description: Public blob access allowed ,
Required: False ,
}
boolean ,
armResourceId:
{
Description: This is populated once the storage account is created. ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
Required: False ,
}
string ,
}
,
storageAccountHnsEnabled:
{
Description: HNS enabled for storage account ,
Required: False ,
}
boolean ,
storageAccountName:
{
Description: Name of the storage account ,
Required: False ,
}
string ,
storageAccountType:
{
Description: Allowed values: "Standard_LRS", "Standard_GRS", "Standard_RAGRS", "Standard_ZRS", "Standard_GZRS", "Standard_RAGZRS", "Premium_LRS", "Premium_ZRS" ,
Required: False ,
}
string ,
}
,
userCreatedStorageAccount:
{
Description: Details of user created storage account to be used for the registry ,
Required: False ,
}
{
armResourceId:
{
Description: ARM ResourceId of a resource ,
Required: False ,
}
{
resourceId:
{
Description: Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" ,
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 ,
}
WorkspaceFeatures_List (new)
Description :  Lists all enabled features for a workspace
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of AML user facing features. ,
Required: False ,
}
[
{
id:
{
Description: Specifies the feature ID ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the feature name ,
Required: False ,
}
string ,
description:
{
Description: Describes the feature for user experience ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of AML user features information. Call ListNext() with this to fetch the next page of AML user features 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 ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available Azure Machine Learning Workspaces REST API operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.MachineLearningServices/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
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 ,
}
,
]
,
}
,
}
Workspaces_ListBySubscription (new)
Description :  Lists all the available machine learning workspaces under the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
kind:
{
Description: Kind of workspace. ,
Required: False ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
aiCapabilities:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page constructed using the continuationToken. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces. ,
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:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
properties:
{
Description: Additional attributes of the entity. ,
Required: True ,
}
{
agentsEndpointUri:
{
Description: The URI of agents endpoint associated with this workspace. ,
Format: url ,
Required: False ,
}
string ,
allowPublicAccessWhenBehindVnet:
{
Description: The flag to indicate whether to allow public access when behind VNet. ,
Required: False ,
}
boolean ,
allowRoleAssignmentOnRG:
{
Description: The flag to indicate whether we will do role assignment for the workspace MSI on resource group level. ,
Required: False ,
}
boolean ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Required: False ,
}
[
string ,
]
,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
discoveryUrl:
{
Description: Url for the discovery service to identify regional endpoints for machine learning experimentation services ,
Required: False ,
}
string ,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableServiceSideCMKEncryption:
{
Required: False ,
}
boolean ,
enableSimplifiedCmk:
{
Description: Flag to tell if simplified CMK should be enabled for this workspace. ,
Required: False ,
}
boolean ,
enableSoftwareBillOfMaterials:
{
Description: Flag to tell if SoftwareBillOfMaterials should be enabled for this workspace. ,
Required: False ,
}
boolean ,
encryption:
{
Required: False ,
}
{
cosmosDbResourceId:
{
Description: The byok cosmosdb account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
identity:
{
Description: Identity to be used with the keyVault ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: UserAssignedIdentity to be used to fetch the encryption key from keyVault ,
Required: False ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault details to do the encryption ,
Required: True ,
}
{
identityClientId:
{
Description: Currently, we support only SystemAssigned MSI. We need this when we support UserAssignedIdentities ,
Required: False ,
}
string ,
keyIdentifier:
{
Description: KeyVault key identifier to encrypt the data ,
Required: True ,
}
string ,
keyVaultArmId:
{
Description: KeyVault Arm Id that contains the data encryption key ,
Required: True ,
}
string ,
}
,
searchAccountResourceId:
{
Description: The byok search account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether or not the encryption is enabled for the workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountResourceId:
{
Description: The byok storage account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
}
,
existingWorkspaces:
{
Required: False ,
}
[
string ,
]
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
hbiWorkspace:
{
Description: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service ,
Required: False ,
}
boolean ,
hubResourceId:
{
Required: False ,
}
string ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
ipAllowlist:
{
Description: The list of IPv4 addresses that are allowed to access the workspace. ,
Required: False ,
}
[
string ,
]
,
keyVault:
{
Description: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
keyVaults:
{
Required: False ,
}
[
string ,
]
,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
changeableIsolationModes:
{
Required: False ,
}
[
string ,
]
,
}
,
mlFlowTrackingUri:
{
Description: The URI associated with this workspace that machine learning flow must point at to set up tracking. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A set of rules governing the network accessibility of the workspace. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: Rules governing the accessibility of a resource from a specific ip address or ip range. ,
Required: False ,
}
[
{
value:
{
Description: An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78). Value could be 'Allow' or 'Deny'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
notebookInfo:
{
Description: The notebook info of Azure ML workspace. ,
Required: False ,
}
{
fqdn:
{
Required: False ,
}
string ,
isPrivateLinkEnabled:
{
Required: False ,
}
boolean ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
Required: False ,
}
string ,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections in the workspace. ,
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 ,
}
,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource. ,
Required: False ,
}
{
id:
{
Description: e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} ,
Required: False ,
}
string ,
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
]
,
privateLinkCount:
{
Description: Count of private connections in the workspace ,
Format: int32 ,
Required: False ,
}
integer ,
provisionNetworkNow:
{
Description: Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Unknown: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
serverlessComputeSettings:
{
Description: Settings for serverless compute in a workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Required: False ,
}
{
collectionsThroughput:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceProvisionedResourceGroup:
{
Description: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace ,
Required: False ,
}
string ,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources in this workspace. ,
Required: False ,
}
[
{
name:
{
Description: Unique name of the private link ,
Required: False ,
}
string ,
properties:
{
Description: Properties of a shared private link resource. ,
Required: False ,
}
{
groupId:
{
Description: group id of the private link ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: the resource id that private link links to ,
Required: False ,
}
string ,
requestMessage:
{
Description: Request message ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
softDeleteRetentionInDays:
{
Description: Retention time in days after workspace get soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccount:
{
Description: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
storageAccounts:
{
Required: False ,
}
[
string ,
]
,
storageHnsEnabled:
{
Description: If the storage associated with the workspace has hierarchical namespace(HNS) enabled. ,
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant id associated with this workspace. ,
Required: False ,
}
string ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
workspaceHubConfig:
{
Description: WorkspaceHub's configuration object. ,
Required: False ,
}
{
additionalWorkspaceStorageAccounts:
{
Required: False ,
}
[
string ,
]
,
defaultWorkspaceResourceGroup:
{
Required: False ,
}
string ,
}
,
workspaceId:
{
Description: The immutable id associated with this workspace. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Workspaces_ListByResourceGroup (new)
Description :  Lists all the available machine learning workspaces under the specified resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page constructed using the continuationToken. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces. ,
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:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
properties:
{
Description: Additional attributes of the entity. ,
Required: True ,
}
{
agentsEndpointUri:
{
Description: The URI of agents endpoint associated with this workspace. ,
Format: url ,
Required: False ,
}
string ,
allowPublicAccessWhenBehindVnet:
{
Description: The flag to indicate whether to allow public access when behind VNet. ,
Required: False ,
}
boolean ,
allowRoleAssignmentOnRG:
{
Description: The flag to indicate whether we will do role assignment for the workspace MSI on resource group level. ,
Required: False ,
}
boolean ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Required: False ,
}
[
string ,
]
,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
discoveryUrl:
{
Description: Url for the discovery service to identify regional endpoints for machine learning experimentation services ,
Required: False ,
}
string ,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableServiceSideCMKEncryption:
{
Required: False ,
}
boolean ,
enableSimplifiedCmk:
{
Description: Flag to tell if simplified CMK should be enabled for this workspace. ,
Required: False ,
}
boolean ,
enableSoftwareBillOfMaterials:
{
Description: Flag to tell if SoftwareBillOfMaterials should be enabled for this workspace. ,
Required: False ,
}
boolean ,
encryption:
{
Required: False ,
}
{
cosmosDbResourceId:
{
Description: The byok cosmosdb account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
identity:
{
Description: Identity to be used with the keyVault ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: UserAssignedIdentity to be used to fetch the encryption key from keyVault ,
Required: False ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault details to do the encryption ,
Required: True ,
}
{
identityClientId:
{
Description: Currently, we support only SystemAssigned MSI. We need this when we support UserAssignedIdentities ,
Required: False ,
}
string ,
keyIdentifier:
{
Description: KeyVault key identifier to encrypt the data ,
Required: True ,
}
string ,
keyVaultArmId:
{
Description: KeyVault Arm Id that contains the data encryption key ,
Required: True ,
}
string ,
}
,
searchAccountResourceId:
{
Description: The byok search account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether or not the encryption is enabled for the workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountResourceId:
{
Description: The byok storage account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
}
,
existingWorkspaces:
{
Required: False ,
}
[
string ,
]
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
hbiWorkspace:
{
Description: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service ,
Required: False ,
}
boolean ,
hubResourceId:
{
Required: False ,
}
string ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
ipAllowlist:
{
Description: The list of IPv4 addresses that are allowed to access the workspace. ,
Required: False ,
}
[
string ,
]
,
keyVault:
{
Description: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
keyVaults:
{
Required: False ,
}
[
string ,
]
,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
changeableIsolationModes:
{
Required: False ,
}
[
string ,
]
,
}
,
mlFlowTrackingUri:
{
Description: The URI associated with this workspace that machine learning flow must point at to set up tracking. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A set of rules governing the network accessibility of the workspace. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: Rules governing the accessibility of a resource from a specific ip address or ip range. ,
Required: False ,
}
[
{
value:
{
Description: An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78). Value could be 'Allow' or 'Deny'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
notebookInfo:
{
Description: The notebook info of Azure ML workspace. ,
Required: False ,
}
{
fqdn:
{
Required: False ,
}
string ,
isPrivateLinkEnabled:
{
Required: False ,
}
boolean ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
Required: False ,
}
string ,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections in the workspace. ,
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 ,
}
,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource. ,
Required: False ,
}
{
id:
{
Description: e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} ,
Required: False ,
}
string ,
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
]
,
privateLinkCount:
{
Description: Count of private connections in the workspace ,
Format: int32 ,
Required: False ,
}
integer ,
provisionNetworkNow:
{
Description: Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Unknown: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
serverlessComputeSettings:
{
Description: Settings for serverless compute in a workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Required: False ,
}
{
collectionsThroughput:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceProvisionedResourceGroup:
{
Description: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace ,
Required: False ,
}
string ,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources in this workspace. ,
Required: False ,
}
[
{
name:
{
Description: Unique name of the private link ,
Required: False ,
}
string ,
properties:
{
Description: Properties of a shared private link resource. ,
Required: False ,
}
{
groupId:
{
Description: group id of the private link ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: the resource id that private link links to ,
Required: False ,
}
string ,
requestMessage:
{
Description: Request message ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
softDeleteRetentionInDays:
{
Description: Retention time in days after workspace get soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccount:
{
Description: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
storageAccounts:
{
Required: False ,
}
[
string ,
]
,
storageHnsEnabled:
{
Description: If the storage associated with the workspace has hierarchical namespace(HNS) enabled. ,
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant id associated with this workspace. ,
Required: False ,
}
string ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
workspaceHubConfig:
{
Description: WorkspaceHub's configuration object. ,
Required: False ,
}
{
additionalWorkspaceStorageAccounts:
{
Required: False ,
}
[
string ,
]
,
defaultWorkspaceResourceGroup:
{
Required: False ,
}
string ,
}
,
workspaceId:
{
Description: The immutable id associated with this workspace. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Workspaces_Delete (new)
Description :  Deletes a machine learning workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
forceToPurge:
{
Description: Flag to indicate delete is a purge request. ,
Required: False ,
}
boolean ,
}

⚐ 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 (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 ,
}
,
]
,
}
,
}
Workspaces_Get (new)
Description :  Gets the properties of the specified machine learning workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}
{
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: Azure Machine Learning Workspace 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:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
properties:
{
Description: Additional attributes of the entity. ,
Required: True ,
}
{
agentsEndpointUri:
{
Description: The URI of agents endpoint associated with this workspace. ,
Format: url ,
Required: False ,
}
string ,
allowPublicAccessWhenBehindVnet:
{
Description: The flag to indicate whether to allow public access when behind VNet. ,
Required: False ,
}
boolean ,
allowRoleAssignmentOnRG:
{
Description: The flag to indicate whether we will do role assignment for the workspace MSI on resource group level. ,
Required: False ,
}
boolean ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Required: False ,
}
[
string ,
]
,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
discoveryUrl:
{
Description: Url for the discovery service to identify regional endpoints for machine learning experimentation services ,
Required: False ,
}
string ,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableServiceSideCMKEncryption:
{
Required: False ,
}
boolean ,
enableSimplifiedCmk:
{
Description: Flag to tell if simplified CMK should be enabled for this workspace. ,
Required: False ,
}
boolean ,
enableSoftwareBillOfMaterials:
{
Description: Flag to tell if SoftwareBillOfMaterials should be enabled for this workspace. ,
Required: False ,
}
boolean ,
encryption:
{
Required: False ,
}
{
cosmosDbResourceId:
{
Description: The byok cosmosdb account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
identity:
{
Description: Identity to be used with the keyVault ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: UserAssignedIdentity to be used to fetch the encryption key from keyVault ,
Required: False ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault details to do the encryption ,
Required: True ,
}
{
identityClientId:
{
Description: Currently, we support only SystemAssigned MSI. We need this when we support UserAssignedIdentities ,
Required: False ,
}
string ,
keyIdentifier:
{
Description: KeyVault key identifier to encrypt the data ,
Required: True ,
}
string ,
keyVaultArmId:
{
Description: KeyVault Arm Id that contains the data encryption key ,
Required: True ,
}
string ,
}
,
searchAccountResourceId:
{
Description: The byok search account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether or not the encryption is enabled for the workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountResourceId:
{
Description: The byok storage account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
}
,
existingWorkspaces:
{
Required: False ,
}
[
string ,
]
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
hbiWorkspace:
{
Description: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service ,
Required: False ,
}
boolean ,
hubResourceId:
{
Required: False ,
}
string ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
ipAllowlist:
{
Description: The list of IPv4 addresses that are allowed to access the workspace. ,
Required: False ,
}
[
string ,
]
,
keyVault:
{
Description: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
keyVaults:
{
Required: False ,
}
[
string ,
]
,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
changeableIsolationModes:
{
Required: False ,
}
[
string ,
]
,
}
,
mlFlowTrackingUri:
{
Description: The URI associated with this workspace that machine learning flow must point at to set up tracking. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A set of rules governing the network accessibility of the workspace. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: Rules governing the accessibility of a resource from a specific ip address or ip range. ,
Required: False ,
}
[
{
value:
{
Description: An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78). Value could be 'Allow' or 'Deny'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
notebookInfo:
{
Description: The notebook info of Azure ML workspace. ,
Required: False ,
}
{
fqdn:
{
Required: False ,
}
string ,
isPrivateLinkEnabled:
{
Required: False ,
}
boolean ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
Required: False ,
}
string ,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections in the workspace. ,
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 ,
}
,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource. ,
Required: False ,
}
{
id:
{
Description: e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} ,
Required: False ,
}
string ,
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
]
,
privateLinkCount:
{
Description: Count of private connections in the workspace ,
Format: int32 ,
Required: False ,
}
integer ,
provisionNetworkNow:
{
Description: Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Unknown: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
serverlessComputeSettings:
{
Description: Settings for serverless compute in a workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Required: False ,
}
{
collectionsThroughput:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceProvisionedResourceGroup:
{
Description: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace ,
Required: False ,
}
string ,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources in this workspace. ,
Required: False ,
}
[
{
name:
{
Description: Unique name of the private link ,
Required: False ,
}
string ,
properties:
{
Description: Properties of a shared private link resource. ,
Required: False ,
}
{
groupId:
{
Description: group id of the private link ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: the resource id that private link links to ,
Required: False ,
}
string ,
requestMessage:
{
Description: Request message ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
softDeleteRetentionInDays:
{
Description: Retention time in days after workspace get soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccount:
{
Description: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
storageAccounts:
{
Required: False ,
}
[
string ,
]
,
storageHnsEnabled:
{
Description: If the storage associated with the workspace has hierarchical namespace(HNS) enabled. ,
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant id associated with this workspace. ,
Required: False ,
}
string ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
workspaceHubConfig:
{
Description: WorkspaceHub's configuration object. ,
Required: False ,
}
{
additionalWorkspaceStorageAccounts:
{
Required: False ,
}
[
string ,
]
,
defaultWorkspaceResourceGroup:
{
Required: False ,
}
string ,
}
,
workspaceId:
{
Description: The immutable id associated with this workspace. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Workspaces_Update (new)
Description :  Updates a machine learning workspace with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The parameters for updating a machine learning workspace. ,
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 ,
}
,
properties:
{
Description: The properties that the machine learning workspace will be updated with. ,
Required: False ,
}
{
allowRoleAssignmentOnRG:
{
Required: False ,
}
boolean ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableSoftwareBillOfMaterials:
{
Description: Flag to tell if SoftwareBillOfMaterials should be enabled for this workspace ,
Required: False ,
}
boolean ,
encryption:
{
Required: False ,
}
{
keyVaultProperties:
{
Required: True ,
}
{
keyIdentifier:
{
Required: True ,
}
string ,
}
,
}
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
ipAllowlist:
{
Description: The list of IPv4 addresses that are allowed to access the workspace. ,
Required: False ,
}
[
string ,
]
,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
changeableIsolationModes:
{
Required: False ,
}
[
string ,
]
,
}
,
networkAcls:
{
Description: A set of rules governing the network accessibility of the workspace. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: Rules governing the accessibility of a resource from a specific ip address or ip range. ,
Required: False ,
}
[
{
value:
{
Description: An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78). Value could be 'Allow' or 'Deny'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
serverlessComputeSettings:
{
Description: Settings for serverless compute in a workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Required: False ,
}
{
collectionsThroughput:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
softDeleteRetentionInDays:
{
Description: Retention time in days after workspace get soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Description: The resource tags for the machine learning workspace. ,
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:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
properties:
{
Description: Additional attributes of the entity. ,
Required: True ,
}
{
agentsEndpointUri:
{
Description: The URI of agents endpoint associated with this workspace. ,
Format: url ,
Required: False ,
}
string ,
allowPublicAccessWhenBehindVnet:
{
Description: The flag to indicate whether to allow public access when behind VNet. ,
Required: False ,
}
boolean ,
allowRoleAssignmentOnRG:
{
Description: The flag to indicate whether we will do role assignment for the workspace MSI on resource group level. ,
Required: False ,
}
boolean ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Required: False ,
}
[
string ,
]
,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
discoveryUrl:
{
Description: Url for the discovery service to identify regional endpoints for machine learning experimentation services ,
Required: False ,
}
string ,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableServiceSideCMKEncryption:
{
Required: False ,
}
boolean ,
enableSimplifiedCmk:
{
Description: Flag to tell if simplified CMK should be enabled for this workspace. ,
Required: False ,
}
boolean ,
enableSoftwareBillOfMaterials:
{
Description: Flag to tell if SoftwareBillOfMaterials should be enabled for this workspace. ,
Required: False ,
}
boolean ,
encryption:
{
Required: False ,
}
{
cosmosDbResourceId:
{
Description: The byok cosmosdb account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
identity:
{
Description: Identity to be used with the keyVault ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: UserAssignedIdentity to be used to fetch the encryption key from keyVault ,
Required: False ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault details to do the encryption ,
Required: True ,
}
{
identityClientId:
{
Description: Currently, we support only SystemAssigned MSI. We need this when we support UserAssignedIdentities ,
Required: False ,
}
string ,
keyIdentifier:
{
Description: KeyVault key identifier to encrypt the data ,
Required: True ,
}
string ,
keyVaultArmId:
{
Description: KeyVault Arm Id that contains the data encryption key ,
Required: True ,
}
string ,
}
,
searchAccountResourceId:
{
Description: The byok search account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether or not the encryption is enabled for the workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountResourceId:
{
Description: The byok storage account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
}
,
existingWorkspaces:
{
Required: False ,
}
[
string ,
]
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
hbiWorkspace:
{
Description: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service ,
Required: False ,
}
boolean ,
hubResourceId:
{
Required: False ,
}
string ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
ipAllowlist:
{
Description: The list of IPv4 addresses that are allowed to access the workspace. ,
Required: False ,
}
[
string ,
]
,
keyVault:
{
Description: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
keyVaults:
{
Required: False ,
}
[
string ,
]
,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
changeableIsolationModes:
{
Required: False ,
}
[
string ,
]
,
}
,
mlFlowTrackingUri:
{
Description: The URI associated with this workspace that machine learning flow must point at to set up tracking. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A set of rules governing the network accessibility of the workspace. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: Rules governing the accessibility of a resource from a specific ip address or ip range. ,
Required: False ,
}
[
{
value:
{
Description: An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78). Value could be 'Allow' or 'Deny'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
notebookInfo:
{
Description: The notebook info of Azure ML workspace. ,
Required: False ,
}
{
fqdn:
{
Required: False ,
}
string ,
isPrivateLinkEnabled:
{
Required: False ,
}
boolean ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
Required: False ,
}
string ,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections in the workspace. ,
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 ,
}
,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource. ,
Required: False ,
}
{
id:
{
Description: e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} ,
Required: False ,
}
string ,
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
]
,
privateLinkCount:
{
Description: Count of private connections in the workspace ,
Format: int32 ,
Required: False ,
}
integer ,
provisionNetworkNow:
{
Description: Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Unknown: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
serverlessComputeSettings:
{
Description: Settings for serverless compute in a workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Required: False ,
}
{
collectionsThroughput:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceProvisionedResourceGroup:
{
Description: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace ,
Required: False ,
}
string ,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources in this workspace. ,
Required: False ,
}
[
{
name:
{
Description: Unique name of the private link ,
Required: False ,
}
string ,
properties:
{
Description: Properties of a shared private link resource. ,
Required: False ,
}
{
groupId:
{
Description: group id of the private link ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: the resource id that private link links to ,
Required: False ,
}
string ,
requestMessage:
{
Description: Request message ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
softDeleteRetentionInDays:
{
Description: Retention time in days after workspace get soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccount:
{
Description: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
storageAccounts:
{
Required: False ,
}
[
string ,
]
,
storageHnsEnabled:
{
Description: If the storage associated with the workspace has hierarchical namespace(HNS) enabled. ,
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant id associated with this workspace. ,
Required: False ,
}
string ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
workspaceHubConfig:
{
Description: WorkspaceHub's configuration object. ,
Required: False ,
}
{
additionalWorkspaceStorageAccounts:
{
Required: False ,
}
[
string ,
]
,
defaultWorkspaceResourceGroup:
{
Required: False ,
}
string ,
}
,
workspaceId:
{
Description: The immutable id associated with this workspace. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Workspaces_CreateOrUpdate (new)
Description :  Creates or updates a workspace with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The parameters for creating or updating a machine learning workspace. ,
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:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
properties:
{
Description: Additional attributes of the entity. ,
Required: True ,
}
{
agentsEndpointUri:
{
Description: The URI of agents endpoint associated with this workspace. ,
Format: url ,
Required: False ,
}
string ,
allowPublicAccessWhenBehindVnet:
{
Description: The flag to indicate whether to allow public access when behind VNet. ,
Required: False ,
}
boolean ,
allowRoleAssignmentOnRG:
{
Description: The flag to indicate whether we will do role assignment for the workspace MSI on resource group level. ,
Required: False ,
}
boolean ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Required: False ,
}
[
string ,
]
,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
discoveryUrl:
{
Description: Url for the discovery service to identify regional endpoints for machine learning experimentation services ,
Required: False ,
}
string ,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableServiceSideCMKEncryption:
{
Required: False ,
}
boolean ,
enableSimplifiedCmk:
{
Description: Flag to tell if simplified CMK should be enabled for this workspace. ,
Required: False ,
}
boolean ,
enableSoftwareBillOfMaterials:
{
Description: Flag to tell if SoftwareBillOfMaterials should be enabled for this workspace. ,
Required: False ,
}
boolean ,
encryption:
{
Required: False ,
}
{
cosmosDbResourceId:
{
Description: The byok cosmosdb account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
identity:
{
Description: Identity to be used with the keyVault ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: UserAssignedIdentity to be used to fetch the encryption key from keyVault ,
Required: False ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault details to do the encryption ,
Required: True ,
}
{
identityClientId:
{
Description: Currently, we support only SystemAssigned MSI. We need this when we support UserAssignedIdentities ,
Required: False ,
}
string ,
keyIdentifier:
{
Description: KeyVault key identifier to encrypt the data ,
Required: True ,
}
string ,
keyVaultArmId:
{
Description: KeyVault Arm Id that contains the data encryption key ,
Required: True ,
}
string ,
}
,
searchAccountResourceId:
{
Description: The byok search account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether or not the encryption is enabled for the workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountResourceId:
{
Description: The byok storage account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
}
,
existingWorkspaces:
{
Required: False ,
}
[
string ,
]
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
hbiWorkspace:
{
Description: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service ,
Required: False ,
}
boolean ,
hubResourceId:
{
Required: False ,
}
string ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
ipAllowlist:
{
Description: The list of IPv4 addresses that are allowed to access the workspace. ,
Required: False ,
}
[
string ,
]
,
keyVault:
{
Description: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
keyVaults:
{
Required: False ,
}
[
string ,
]
,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
changeableIsolationModes:
{
Required: False ,
}
[
string ,
]
,
}
,
mlFlowTrackingUri:
{
Description: The URI associated with this workspace that machine learning flow must point at to set up tracking. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A set of rules governing the network accessibility of the workspace. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: Rules governing the accessibility of a resource from a specific ip address or ip range. ,
Required: False ,
}
[
{
value:
{
Description: An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78). Value could be 'Allow' or 'Deny'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
notebookInfo:
{
Description: The notebook info of Azure ML workspace. ,
Required: False ,
}
{
fqdn:
{
Required: False ,
}
string ,
isPrivateLinkEnabled:
{
Required: False ,
}
boolean ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
Required: False ,
}
string ,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections in the workspace. ,
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 ,
}
,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource. ,
Required: False ,
}
{
id:
{
Description: e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} ,
Required: False ,
}
string ,
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
]
,
privateLinkCount:
{
Description: Count of private connections in the workspace ,
Format: int32 ,
Required: False ,
}
integer ,
provisionNetworkNow:
{
Description: Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Unknown: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
serverlessComputeSettings:
{
Description: Settings for serverless compute in a workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Required: False ,
}
{
collectionsThroughput:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceProvisionedResourceGroup:
{
Description: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace ,
Required: False ,
}
string ,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources in this workspace. ,
Required: False ,
}
[
{
name:
{
Description: Unique name of the private link ,
Required: False ,
}
string ,
properties:
{
Description: Properties of a shared private link resource. ,
Required: False ,
}
{
groupId:
{
Description: group id of the private link ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: the resource id that private link links to ,
Required: False ,
}
string ,
requestMessage:
{
Description: Request message ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
softDeleteRetentionInDays:
{
Description: Retention time in days after workspace get soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccount:
{
Description: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
storageAccounts:
{
Required: False ,
}
[
string ,
]
,
storageHnsEnabled:
{
Description: If the storage associated with the workspace has hierarchical namespace(HNS) enabled. ,
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant id associated with this workspace. ,
Required: False ,
}
string ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
workspaceHubConfig:
{
Description: WorkspaceHub's configuration object. ,
Required: False ,
}
{
additionalWorkspaceStorageAccounts:
{
Required: False ,
}
[
string ,
]
,
defaultWorkspaceResourceGroup:
{
Required: False ,
}
string ,
}
,
workspaceId:
{
Description: The immutable id associated with this workspace. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
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:
{
Required: False ,
}
string ,
location:
{
Required: False ,
}
string ,
properties:
{
Description: Additional attributes of the entity. ,
Required: True ,
}
{
agentsEndpointUri:
{
Description: The URI of agents endpoint associated with this workspace. ,
Format: url ,
Required: False ,
}
string ,
allowPublicAccessWhenBehindVnet:
{
Description: The flag to indicate whether to allow public access when behind VNet. ,
Required: False ,
}
boolean ,
allowRoleAssignmentOnRG:
{
Description: The flag to indicate whether we will do role assignment for the workspace MSI on resource group level. ,
Required: False ,
}
boolean ,
applicationInsights:
{
Description: ARM id of the application insights associated with this workspace. ,
Required: False ,
}
string ,
associatedWorkspaces:
{
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Required: False ,
}
[
string ,
]
,
containerRegistry:
{
Description: ARM id of the container registry associated with this workspace. ,
Required: False ,
}
string ,
description:
{
Description: The description of this workspace. ,
Required: False ,
}
string ,
discoveryUrl:
{
Description: Url for the discovery service to identify regional endpoints for machine learning experimentation services ,
Required: False ,
}
string ,
enableDataIsolation:
{
Required: False ,
}
boolean ,
enableServiceSideCMKEncryption:
{
Required: False ,
}
boolean ,
enableSimplifiedCmk:
{
Description: Flag to tell if simplified CMK should be enabled for this workspace. ,
Required: False ,
}
boolean ,
enableSoftwareBillOfMaterials:
{
Description: Flag to tell if SoftwareBillOfMaterials should be enabled for this workspace. ,
Required: False ,
}
boolean ,
encryption:
{
Required: False ,
}
{
cosmosDbResourceId:
{
Description: The byok cosmosdb account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
identity:
{
Description: Identity to be used with the keyVault ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: UserAssignedIdentity to be used to fetch the encryption key from keyVault ,
Required: False ,
}
string ,
}
,
keyVaultProperties:
{
Description: KeyVault details to do the encryption ,
Required: True ,
}
{
identityClientId:
{
Description: Currently, we support only SystemAssigned MSI. We need this when we support UserAssignedIdentities ,
Required: False ,
}
string ,
keyIdentifier:
{
Description: KeyVault key identifier to encrypt the data ,
Required: True ,
}
string ,
keyVaultArmId:
{
Description: KeyVault Arm Id that contains the data encryption key ,
Required: True ,
}
string ,
}
,
searchAccountResourceId:
{
Description: The byok search account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
status:
{
Description: Indicates whether or not the encryption is enabled for the workspace. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
storageAccountResourceId:
{
Description: The byok storage account that customer brings to store customer's data with encryption ,
Required: False ,
}
string ,
}
,
existingWorkspaces:
{
Required: False ,
}
[
string ,
]
,
featureStoreSettings:
{
Description: Settings for feature store type workspace. ,
Required: False ,
}
{
computeRuntime:
{
Required: False ,
}
{
sparkRuntimeVersion:
{
Required: False ,
}
string ,
}
,
offlineStoreConnectionName:
{
Required: False ,
}
string ,
onlineStoreConnectionName:
{
Required: False ,
}
string ,
}
,
friendlyName:
{
Description: The friendly name for this workspace. This name in mutable ,
Required: False ,
}
string ,
hbiWorkspace:
{
Description: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service ,
Required: False ,
}
boolean ,
hubResourceId:
{
Required: False ,
}
string ,
imageBuildCompute:
{
Description: The compute name for image build ,
Required: False ,
}
string ,
ipAllowlist:
{
Description: The list of IPv4 addresses that are allowed to access the workspace. ,
Required: False ,
}
[
string ,
]
,
keyVault:
{
Description: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
keyVaults:
{
Required: False ,
}
[
string ,
]
,
managedNetwork:
{
Description: Managed Network settings for a machine learning workspace. ,
Required: False ,
}
{
firewallPublicIpAddress:
{
Description: Public IP address assigned to the Azure Firewall. ,
Required: False ,
}
string ,
firewallSku:
{
Description: Firewall Sku used for FQDN Rules ,
Enum:
{
Standard: No description available. ,
Basic: No description available. ,
}
,
Required: False ,
}
enum ,
isolationMode:
{
Description: Isolation mode for the managed network of a machine learning workspace. ,
Enum:
{
Disabled: No description available. ,
AllowInternetOutbound: No description available. ,
AllowOnlyApprovedOutbound: No description available. ,
}
,
Required: False ,
}
enum ,
networkId:
{
Required: False ,
}
string ,
outboundRules:
{
Required: False ,
}
object ,
status:
{
Description: Status of the Provisioning for the managed network of a machine learning workspace. ,
Required: False ,
}
{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
changeableIsolationModes:
{
Required: False ,
}
[
string ,
]
,
}
,
mlFlowTrackingUri:
{
Description: The URI associated with this workspace that machine learning flow must point at to set up tracking. ,
Required: False ,
}
string ,
networkAcls:
{
Description: A set of rules governing the network accessibility of the workspace. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. ,
Enum:
{
Deny: No description available. ,
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
ipRules:
{
Description: Rules governing the accessibility of a resource from a specific ip address or ip range. ,
Required: False ,
}
[
{
value:
{
Description: An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78). Value could be 'Allow' or 'Deny'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
notebookInfo:
{
Description: The notebook info of Azure ML workspace. ,
Required: False ,
}
{
fqdn:
{
Required: False ,
}
string ,
isPrivateLinkEnabled:
{
Required: False ,
}
boolean ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
Required: False ,
}
string ,
}
,
primaryUserAssignedIdentity:
{
Description: The user assigned identity resource id that represents the workspace identity. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The list of private endpoint connections in the workspace. ,
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 ,
}
,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource. ,
Required: False ,
}
{
id:
{
Description: e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} ,
Required: False ,
}
string ,
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
]
,
privateLinkCount:
{
Description: Count of private connections in the workspace ,
Format: int32 ,
Required: False ,
}
integer ,
provisionNetworkNow:
{
Description: Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Unknown: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Whether requests from Public Network are allowed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
serverlessComputeSettings:
{
Description: Settings for serverless compute in a workspace ,
Required: False ,
}
{
serverlessComputeCustomSubnet:
{
Description: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed ,
Format: arm-id ,
Required: False ,
}
string ,
serverlessComputeNoPublicIP:
{
Description: The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint ,
Required: False ,
}
boolean ,
}
,
serviceManagedResourcesSettings:
{
Description: The service managed resource settings. ,
Required: False ,
}
{
cosmosDb:
{
Required: False ,
}
{
collectionsThroughput:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
serviceProvisionedResourceGroup:
{
Description: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace ,
Required: False ,
}
string ,
sharedPrivateLinkResources:
{
Description: The list of shared private link resources in this workspace. ,
Required: False ,
}
[
{
name:
{
Description: Unique name of the private link ,
Required: False ,
}
string ,
properties:
{
Description: Properties of a shared private link resource. ,
Required: False ,
}
{
groupId:
{
Description: group id of the private link ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: the resource id that private link links to ,
Required: False ,
}
string ,
requestMessage:
{
Description: Request message ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
softDeleteRetentionInDays:
{
Description: Retention time in days after workspace get soft deleted. ,
Format: int32 ,
Required: False ,
}
integer ,
storageAccount:
{
Description: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created ,
Required: False ,
}
string ,
storageAccounts:
{
Required: False ,
}
[
string ,
]
,
storageHnsEnabled:
{
Description: If the storage associated with the workspace has hierarchical namespace(HNS) enabled. ,
Required: False ,
}
boolean ,
systemDatastoresAuthMode:
{
Description: The auth mode used for accessing the system datastores of the workspace. ,
Enum:
{
AccessKey: No description available. ,
Identity: No description available. ,
UserDelegationSAS: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant id associated with this workspace. ,
Required: False ,
}
string ,
v1LegacyMode:
{
Description: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. ,
Required: False ,
}
boolean ,
workspaceHubConfig:
{
Description: WorkspaceHub's configuration object. ,
Required: False ,
}
{
additionalWorkspaceStorageAccounts:
{
Required: False ,
}
[
string ,
]
,
defaultWorkspaceResourceGroup:
{
Required: False ,
}
string ,
}
,
workspaceId:
{
Description: The immutable id associated with this workspace. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
WorkspaceConnections_List (new)
Description :  Lists all the available machine learning workspaces connections under the specified workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
target:
{
Description: Target of the workspace connection. ,
Required: False ,
}
string ,
category:
{
Description: Category of the workspace connection. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
includeAll:
{
Description: query parameter that indicates if get connection call should return both connections and datastores ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
nextLink:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
authType:
{
Description: Authentication type of the connection target ,
Enum:
{
PAT: No description available. ,
ManagedIdentity: No description available. ,
UsernamePassword: No description available. ,
None: No description available. ,
SAS: No description available. ,
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
AccessKey: No description available. ,
ApiKey: No description available. ,
CustomKeys: No description available. ,
OAuth2: No description available. ,
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
category:
{
Description: Category of the connection ,
Enum:
{
PythonFeed: No description available. ,
ContainerRegistry: No description available. ,
Git: No description available. ,
S3: No description available. ,
Snowflake: No description available. ,
AzureSqlDb: No description available. ,
AzureSynapseAnalytics: No description available. ,
AzureMySqlDb: No description available. ,
AzurePostgresDb: No description available. ,
ADLSGen2: No description available. ,
Redis: No description available. ,
ApiKey: No description available. ,
AzureOpenAI: No description available. ,
AIServices: No description available. ,
CognitiveSearch: No description available. ,
CognitiveService: No description available. ,
CustomKeys: No description available. ,
AzureBlob: No description available. ,
AzureOneLake: No description available. ,
CosmosDb: No description available. ,
CosmosDbMongoDbApi: No description available. ,
AzureDataExplorer: No description available. ,
AzureMariaDb: No description available. ,
AzureDatabricksDeltaLake: No description available. ,
AzureSqlMi: No description available. ,
AzureTableStorage: No description available. ,
AmazonRdsForOracle: No description available. ,
AmazonRdsForSqlServer: No description available. ,
AmazonRedshift: No description available. ,
Db2: No description available. ,
Drill: No description available. ,
GoogleBigQuery: No description available. ,
Greenplum: No description available. ,
Hbase: No description available. ,
Hive: No description available. ,
Impala: No description available. ,
Informix: No description available. ,
MariaDb: No description available. ,
MicrosoftAccess: No description available. ,
MySql: No description available. ,
Netezza: No description available. ,
Oracle: No description available. ,
Phoenix: No description available. ,
PostgreSql: No description available. ,
Presto: No description available. ,
SapOpenHub: No description available. ,
SapBw: No description available. ,
SapHana: No description available. ,
SapTable: No description available. ,
Spark: No description available. ,
SqlServer: No description available. ,
Sybase: No description available. ,
Teradata: No description available. ,
Vertica: No description available. ,
Pinecone: No description available. ,
Cassandra: No description available. ,
Couchbase: No description available. ,
MongoDbV2: No description available. ,
MongoDbAtlas: No description available. ,
AmazonS3Compatible: No description available. ,
FileServer: No description available. ,
FtpServer: No description available. ,
GoogleCloudStorage: No description available. ,
Hdfs: No description available. ,
OracleCloudStorage: No description available. ,
Sftp: No description available. ,
GenericHttp: No description available. ,
ODataRest: No description available. ,
Odbc: No description available. ,
GenericRest: No description available. ,
AmazonMws: No description available. ,
Concur: No description available. ,
Dynamics: No description available. ,
DynamicsAx: No description available. ,
DynamicsCrm: No description available. ,
GoogleAdWords: No description available. ,
Hubspot: No description available. ,
Jira: No description available. ,
Magento: No description available. ,
Marketo: No description available. ,
Office365: No description available. ,
Eloqua: No description available. ,
Responsys: No description available. ,
OracleServiceCloud: No description available. ,
PayPal: No description available. ,
QuickBooks: No description available. ,
Salesforce: No description available. ,
SalesforceServiceCloud: No description available. ,
SalesforceMarketingCloud: No description available. ,
SapCloudForCustomer: No description available. ,
SapEcc: No description available. ,
ServiceNow: No description available. ,
SharePointOnlineList: No description available. ,
Shopify: No description available. ,
Square: No description available. ,
WebTable: No description available. ,
Xero: No description available. ,
Zoho: No description available. ,
GenericContainerRegistry: No description available. ,
Elasticsearch: No description available. ,
OpenAI: No description available. ,
Serp: No description available. ,
BingLLMSearch: No description available. ,
Serverless: No description available. ,
ManagedOnlineEndpoint: No description available. ,
}
,
Required: False ,
}
enum ,
createdByWorkspaceArmId:
{
Format: arm-id ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
expiryTime:
{
Format: date-time ,
Required: False ,
}
string ,
group:
{
Description: Group based on connection category ,
Enum:
{
Azure: No description available. ,
AzureAI: No description available. ,
Database: No description available. ,
NoSQL: No description available. ,
File: No description available. ,
GenericProtocol: No description available. ,
ServicesAndApps: No description available. ,
}
,
Required: False ,
}
enum ,
isSharedToAll:
{
Required: False ,
}
boolean ,
metadata:
{
Description: Store user metadata for this connection ,
Required: False ,
}
object ,
peRequirement:
{
Enum:
{
Required: No description available. ,
NotRequired: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
peStatus:
{
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sharedUserList:
{
Required: False ,
}
[
string ,
]
,
target:
{
Required: False ,
}
string ,
useWorkspaceManagedIdentity:
{
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 ,
}
,
]
,
}
,
}
WorkspaceConnections_Delete (new)
Description :  Delete machine learning workspaces connections by name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
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 ,
}
,
]
,
}
,
}
WorkspaceConnections_Get (new)
Description :  Lists machine learning workspaces connections by name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
authType:
{
Description: Authentication type of the connection target ,
Enum:
{
PAT: No description available. ,
ManagedIdentity: No description available. ,
UsernamePassword: No description available. ,
None: No description available. ,
SAS: No description available. ,
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
AccessKey: No description available. ,
ApiKey: No description available. ,
CustomKeys: No description available. ,
OAuth2: No description available. ,
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
category:
{
Description: Category of the connection ,
Enum:
{
PythonFeed: No description available. ,
ContainerRegistry: No description available. ,
Git: No description available. ,
S3: No description available. ,
Snowflake: No description available. ,
AzureSqlDb: No description available. ,
AzureSynapseAnalytics: No description available. ,
AzureMySqlDb: No description available. ,
AzurePostgresDb: No description available. ,
ADLSGen2: No description available. ,
Redis: No description available. ,
ApiKey: No description available. ,
AzureOpenAI: No description available. ,
AIServices: No description available. ,
CognitiveSearch: No description available. ,
CognitiveService: No description available. ,
CustomKeys: No description available. ,
AzureBlob: No description available. ,
AzureOneLake: No description available. ,
CosmosDb: No description available. ,
CosmosDbMongoDbApi: No description available. ,
AzureDataExplorer: No description available. ,
AzureMariaDb: No description available. ,
AzureDatabricksDeltaLake: No description available. ,
AzureSqlMi: No description available. ,
AzureTableStorage: No description available. ,
AmazonRdsForOracle: No description available. ,
AmazonRdsForSqlServer: No description available. ,
AmazonRedshift: No description available. ,
Db2: No description available. ,
Drill: No description available. ,
GoogleBigQuery: No description available. ,
Greenplum: No description available. ,
Hbase: No description available. ,
Hive: No description available. ,
Impala: No description available. ,
Informix: No description available. ,
MariaDb: No description available. ,
MicrosoftAccess: No description available. ,
MySql: No description available. ,
Netezza: No description available. ,
Oracle: No description available. ,
Phoenix: No description available. ,
PostgreSql: No description available. ,
Presto: No description available. ,
SapOpenHub: No description available. ,
SapBw: No description available. ,
SapHana: No description available. ,
SapTable: No description available. ,
Spark: No description available. ,
SqlServer: No description available. ,
Sybase: No description available. ,
Teradata: No description available. ,
Vertica: No description available. ,
Pinecone: No description available. ,
Cassandra: No description available. ,
Couchbase: No description available. ,
MongoDbV2: No description available. ,
MongoDbAtlas: No description available. ,
AmazonS3Compatible: No description available. ,
FileServer: No description available. ,
FtpServer: No description available. ,
GoogleCloudStorage: No description available. ,
Hdfs: No description available. ,
OracleCloudStorage: No description available. ,
Sftp: No description available. ,
GenericHttp: No description available. ,
ODataRest: No description available. ,
Odbc: No description available. ,
GenericRest: No description available. ,
AmazonMws: No description available. ,
Concur: No description available. ,
Dynamics: No description available. ,
DynamicsAx: No description available. ,
DynamicsCrm: No description available. ,
GoogleAdWords: No description available. ,
Hubspot: No description available. ,
Jira: No description available. ,
Magento: No description available. ,
Marketo: No description available. ,
Office365: No description available. ,
Eloqua: No description available. ,
Responsys: No description available. ,
OracleServiceCloud: No description available. ,
PayPal: No description available. ,
QuickBooks: No description available. ,
Salesforce: No description available. ,
SalesforceServiceCloud: No description available. ,
SalesforceMarketingCloud: No description available. ,
SapCloudForCustomer: No description available. ,
SapEcc: No description available. ,
ServiceNow: No description available. ,
SharePointOnlineList: No description available. ,
Shopify: No description available. ,
Square: No description available. ,
WebTable: No description available. ,
Xero: No description available. ,
Zoho: No description available. ,
GenericContainerRegistry: No description available. ,
Elasticsearch: No description available. ,
OpenAI: No description available. ,
Serp: No description available. ,
BingLLMSearch: No description available. ,
Serverless: No description available. ,
ManagedOnlineEndpoint: No description available. ,
}
,
Required: False ,
}
enum ,
createdByWorkspaceArmId:
{
Format: arm-id ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
expiryTime:
{
Format: date-time ,
Required: False ,
}
string ,
group:
{
Description: Group based on connection category ,
Enum:
{
Azure: No description available. ,
AzureAI: No description available. ,
Database: No description available. ,
NoSQL: No description available. ,
File: No description available. ,
GenericProtocol: No description available. ,
ServicesAndApps: No description available. ,
}
,
Required: False ,
}
enum ,
isSharedToAll:
{
Required: False ,
}
boolean ,
metadata:
{
Description: Store user metadata for this connection ,
Required: False ,
}
object ,
peRequirement:
{
Enum:
{
Required: No description available. ,
NotRequired: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
peStatus:
{
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sharedUserList:
{
Required: False ,
}
[
string ,
]
,
target:
{
Required: False ,
}
string ,
useWorkspaceManagedIdentity:
{
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 ,
}
,
]
,
}
,
}
WorkspaceConnections_Update (new)
Description :  Update machine learning workspaces connections under the specified workspace.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Parameters for workspace connection update. ,
Required: False ,
}
{
properties:
{
Description: The properties that the machine learning workspace connection will be updated with. ,
Required: False ,
}
{
authType:
{
Description: Authentication type of the connection target ,
Enum:
{
PAT: No description available. ,
ManagedIdentity: No description available. ,
UsernamePassword: No description available. ,
None: No description available. ,
SAS: No description available. ,
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
AccessKey: No description available. ,
ApiKey: No description available. ,
CustomKeys: No description available. ,
OAuth2: No description available. ,
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
category:
{
Description: Category of the connection ,
Enum:
{
PythonFeed: No description available. ,
ContainerRegistry: No description available. ,
Git: No description available. ,
S3: No description available. ,
Snowflake: No description available. ,
AzureSqlDb: No description available. ,
AzureSynapseAnalytics: No description available. ,
AzureMySqlDb: No description available. ,
AzurePostgresDb: No description available. ,
ADLSGen2: No description available. ,
Redis: No description available. ,
ApiKey: No description available. ,
AzureOpenAI: No description available. ,
AIServices: No description available. ,
CognitiveSearch: No description available. ,
CognitiveService: No description available. ,
CustomKeys: No description available. ,
AzureBlob: No description available. ,
AzureOneLake: No description available. ,
CosmosDb: No description available. ,
CosmosDbMongoDbApi: No description available. ,
AzureDataExplorer: No description available. ,
AzureMariaDb: No description available. ,
AzureDatabricksDeltaLake: No description available. ,
AzureSqlMi: No description available. ,
AzureTableStorage: No description available. ,
AmazonRdsForOracle: No description available. ,
AmazonRdsForSqlServer: No description available. ,
AmazonRedshift: No description available. ,
Db2: No description available. ,
Drill: No description available. ,
GoogleBigQuery: No description available. ,
Greenplum: No description available. ,
Hbase: No description available. ,
Hive: No description available. ,
Impala: No description available. ,
Informix: No description available. ,
MariaDb: No description available. ,
MicrosoftAccess: No description available. ,
MySql: No description available. ,
Netezza: No description available. ,
Oracle: No description available. ,
Phoenix: No description available. ,
PostgreSql: No description available. ,
Presto: No description available. ,
SapOpenHub: No description available. ,
SapBw: No description available. ,
SapHana: No description available. ,
SapTable: No description available. ,
Spark: No description available. ,
SqlServer: No description available. ,
Sybase: No description available. ,
Teradata: No description available. ,
Vertica: No description available. ,
Pinecone: No description available. ,
Cassandra: No description available. ,
Couchbase: No description available. ,
MongoDbV2: No description available. ,
MongoDbAtlas: No description available. ,
AmazonS3Compatible: No description available. ,
FileServer: No description available. ,
FtpServer: No description available. ,
GoogleCloudStorage: No description available. ,
Hdfs: No description available. ,
OracleCloudStorage: No description available. ,
Sftp: No description available. ,
GenericHttp: No description available. ,
ODataRest: No description available. ,
Odbc: No description available. ,
GenericRest: No description available. ,
AmazonMws: No description available. ,
Concur: No description available. ,
Dynamics: No description available. ,
DynamicsAx: No description available. ,
DynamicsCrm: No description available. ,
GoogleAdWords: No description available. ,
Hubspot: No description available. ,
Jira: No description available. ,
Magento: No description available. ,
Marketo: No description available. ,
Office365: No description available. ,
Eloqua: No description available. ,
Responsys: No description available. ,
OracleServiceCloud: No description available. ,
PayPal: No description available. ,
QuickBooks: No description available. ,
Salesforce: No description available. ,
SalesforceServiceCloud: No description available. ,
SalesforceMarketingCloud: No description available. ,
SapCloudForCustomer: No description available. ,
SapEcc: No description available. ,
ServiceNow: No description available. ,
SharePointOnlineList: No description available. ,
Shopify: No description available. ,
Square: No description available. ,
WebTable: No description available. ,
Xero: No description available. ,
Zoho: No description available. ,
GenericContainerRegistry: No description available. ,
Elasticsearch: No description available. ,
OpenAI: No description available. ,
Serp: No description available. ,
BingLLMSearch: No description available. ,
Serverless: No description available. ,
ManagedOnlineEndpoint: No description available. ,
}
,
Required: False ,
}
enum ,
createdByWorkspaceArmId:
{
Format: arm-id ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
expiryTime:
{
Format: date-time ,
Required: False ,
}
string ,
group:
{
Description: Group based on connection category ,
Enum:
{
Azure: No description available. ,
AzureAI: No description available. ,
Database: No description available. ,
NoSQL: No description available. ,
File: No description available. ,
GenericProtocol: No description available. ,
ServicesAndApps: No description available. ,
}
,
Required: False ,
}
enum ,
isSharedToAll:
{
Required: False ,
}
boolean ,
metadata:
{
Description: Store user metadata for this connection ,
Required: False ,
}
object ,
peRequirement:
{
Enum:
{
Required: No description available. ,
NotRequired: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
peStatus:
{
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sharedUserList:
{
Required: False ,
}
[
string ,
]
,
target:
{
Required: False ,
}
string ,
useWorkspaceManagedIdentity:
{
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
authType:
{
Description: Authentication type of the connection target ,
Enum:
{
PAT: No description available. ,
ManagedIdentity: No description available. ,
UsernamePassword: No description available. ,
None: No description available. ,
SAS: No description available. ,
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
AccessKey: No description available. ,
ApiKey: No description available. ,
CustomKeys: No description available. ,
OAuth2: No description available. ,
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
category:
{
Description: Category of the connection ,
Enum:
{
PythonFeed: No description available. ,
ContainerRegistry: No description available. ,
Git: No description available. ,
S3: No description available. ,
Snowflake: No description available. ,
AzureSqlDb: No description available. ,
AzureSynapseAnalytics: No description available. ,
AzureMySqlDb: No description available. ,
AzurePostgresDb: No description available. ,
ADLSGen2: No description available. ,
Redis: No description available. ,
ApiKey: No description available. ,
AzureOpenAI: No description available. ,
AIServices: No description available. ,
CognitiveSearch: No description available. ,
CognitiveService: No description available. ,
CustomKeys: No description available. ,
AzureBlob: No description available. ,
AzureOneLake: No description available. ,
CosmosDb: No description available. ,
CosmosDbMongoDbApi: No description available. ,
AzureDataExplorer: No description available. ,
AzureMariaDb: No description available. ,
AzureDatabricksDeltaLake: No description available. ,
AzureSqlMi: No description available. ,
AzureTableStorage: No description available. ,
AmazonRdsForOracle: No description available. ,
AmazonRdsForSqlServer: No description available. ,
AmazonRedshift: No description available. ,
Db2: No description available. ,
Drill: No description available. ,
GoogleBigQuery: No description available. ,
Greenplum: No description available. ,
Hbase: No description available. ,
Hive: No description available. ,
Impala: No description available. ,
Informix: No description available. ,
MariaDb: No description available. ,
MicrosoftAccess: No description available. ,
MySql: No description available. ,
Netezza: No description available. ,
Oracle: No description available. ,
Phoenix: No description available. ,
PostgreSql: No description available. ,
Presto: No description available. ,
SapOpenHub: No description available. ,
SapBw: No description available. ,
SapHana: No description available. ,
SapTable: No description available. ,
Spark: No description available. ,
SqlServer: No description available. ,
Sybase: No description available. ,
Teradata: No description available. ,
Vertica: No description available. ,
Pinecone: No description available. ,
Cassandra: No description available. ,
Couchbase: No description available. ,
MongoDbV2: No description available. ,
MongoDbAtlas: No description available. ,
AmazonS3Compatible: No description available. ,
FileServer: No description available. ,
FtpServer: No description available. ,
GoogleCloudStorage: No description available. ,
Hdfs: No description available. ,
OracleCloudStorage: No description available. ,
Sftp: No description available. ,
GenericHttp: No description available. ,
ODataRest: No description available. ,
Odbc: No description available. ,
GenericRest: No description available. ,
AmazonMws: No description available. ,
Concur: No description available. ,
Dynamics: No description available. ,
DynamicsAx: No description available. ,
DynamicsCrm: No description available. ,
GoogleAdWords: No description available. ,
Hubspot: No description available. ,
Jira: No description available. ,
Magento: No description available. ,
Marketo: No description available. ,
Office365: No description available. ,
Eloqua: No description available. ,
Responsys: No description available. ,
OracleServiceCloud: No description available. ,
PayPal: No description available. ,
QuickBooks: No description available. ,
Salesforce: No description available. ,
SalesforceServiceCloud: No description available. ,
SalesforceMarketingCloud: No description available. ,
SapCloudForCustomer: No description available. ,
SapEcc: No description available. ,
ServiceNow: No description available. ,
SharePointOnlineList: No description available. ,
Shopify: No description available. ,
Square: No description available. ,
WebTable: No description available. ,
Xero: No description available. ,
Zoho: No description available. ,
GenericContainerRegistry: No description available. ,
Elasticsearch: No description available. ,
OpenAI: No description available. ,
Serp: No description available. ,
BingLLMSearch: No description available. ,
Serverless: No description available. ,
ManagedOnlineEndpoint: No description available. ,
}
,
Required: False ,
}
enum ,
createdByWorkspaceArmId:
{
Format: arm-id ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
expiryTime:
{
Format: date-time ,
Required: False ,
}
string ,
group:
{
Description: Group based on connection category ,
Enum:
{
Azure: No description available. ,
AzureAI: No description available. ,
Database: No description available. ,
NoSQL: No description available. ,
File: No description available. ,
GenericProtocol: No description available. ,
ServicesAndApps: No description available. ,
}
,
Required: False ,
}
enum ,
isSharedToAll:
{
Required: False ,
}
boolean ,
metadata:
{
Description: Store user metadata for this connection ,
Required: False ,
}
object ,
peRequirement:
{
Enum:
{
Required: No description available. ,
NotRequired: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
peStatus:
{
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sharedUserList:
{
Required: False ,
}
[
string ,
]
,
target:
{
Required: False ,
}
string ,
useWorkspaceManagedIdentity:
{
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 ,
}
,
]
,
}
,
}
WorkspaceConnections_Create (new)
Description :  Create or update machine learning workspaces connections under the specified workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The object for creating or updating a new workspace connection ,
Required: False ,
}
{
properties:
{
Required: True ,
}
{
authType:
{
Description: Authentication type of the connection target ,
Enum:
{
PAT: No description available. ,
ManagedIdentity: No description available. ,
UsernamePassword: No description available. ,
None: No description available. ,
SAS: No description available. ,
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
AccessKey: No description available. ,
ApiKey: No description available. ,
CustomKeys: No description available. ,
OAuth2: No description available. ,
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
category:
{
Description: Category of the connection ,
Enum:
{
PythonFeed: No description available. ,
ContainerRegistry: No description available. ,
Git: No description available. ,
S3: No description available. ,
Snowflake: No description available. ,
AzureSqlDb: No description available. ,
AzureSynapseAnalytics: No description available. ,
AzureMySqlDb: No description available. ,
AzurePostgresDb: No description available. ,
ADLSGen2: No description available. ,
Redis: No description available. ,
ApiKey: No description available. ,
AzureOpenAI: No description available. ,
AIServices: No description available. ,
CognitiveSearch: No description available. ,
CognitiveService: No description available. ,
CustomKeys: No description available. ,
AzureBlob: No description available. ,
AzureOneLake: No description available. ,
CosmosDb: No description available. ,
CosmosDbMongoDbApi: No description available. ,
AzureDataExplorer: No description available. ,
AzureMariaDb: No description available. ,
AzureDatabricksDeltaLake: No description available. ,
AzureSqlMi: No description available. ,
AzureTableStorage: No description available. ,
AmazonRdsForOracle: No description available. ,
AmazonRdsForSqlServer: No description available. ,
AmazonRedshift: No description available. ,
Db2: No description available. ,
Drill: No description available. ,
GoogleBigQuery: No description available. ,
Greenplum: No description available. ,
Hbase: No description available. ,
Hive: No description available. ,
Impala: No description available. ,
Informix: No description available. ,
MariaDb: No description available. ,
MicrosoftAccess: No description available. ,
MySql: No description available. ,
Netezza: No description available. ,
Oracle: No description available. ,
Phoenix: No description available. ,
PostgreSql: No description available. ,
Presto: No description available. ,
SapOpenHub: No description available. ,
SapBw: No description available. ,
SapHana: No description available. ,
SapTable: No description available. ,
Spark: No description available. ,
SqlServer: No description available. ,
Sybase: No description available. ,
Teradata: No description available. ,
Vertica: No description available. ,
Pinecone: No description available. ,
Cassandra: No description available. ,
Couchbase: No description available. ,
MongoDbV2: No description available. ,
MongoDbAtlas: No description available. ,
AmazonS3Compatible: No description available. ,
FileServer: No description available. ,
FtpServer: No description available. ,
GoogleCloudStorage: No description available. ,
Hdfs: No description available. ,
OracleCloudStorage: No description available. ,
Sftp: No description available. ,
GenericHttp: No description available. ,
ODataRest: No description available. ,
Odbc: No description available. ,
GenericRest: No description available. ,
AmazonMws: No description available. ,
Concur: No description available. ,
Dynamics: No description available. ,
DynamicsAx: No description available. ,
DynamicsCrm: No description available. ,
GoogleAdWords: No description available. ,
Hubspot: No description available. ,
Jira: No description available. ,
Magento: No description available. ,
Marketo: No description available. ,
Office365: No description available. ,
Eloqua: No description available. ,
Responsys: No description available. ,
OracleServiceCloud: No description available. ,
PayPal: No description available. ,
QuickBooks: No description available. ,
Salesforce: No description available. ,
SalesforceServiceCloud: No description available. ,
SalesforceMarketingCloud: No description available. ,
SapCloudForCustomer: No description available. ,
SapEcc: No description available. ,
ServiceNow: No description available. ,
SharePointOnlineList: No description available. ,
Shopify: No description available. ,
Square: No description available. ,
WebTable: No description available. ,
Xero: No description available. ,
Zoho: No description available. ,
GenericContainerRegistry: No description available. ,
Elasticsearch: No description available. ,
OpenAI: No description available. ,
Serp: No description available. ,
BingLLMSearch: No description available. ,
Serverless: No description available. ,
ManagedOnlineEndpoint: No description available. ,
}
,
Required: False ,
}
enum ,
createdByWorkspaceArmId:
{
Format: arm-id ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
expiryTime:
{
Format: date-time ,
Required: False ,
}
string ,
group:
{
Description: Group based on connection category ,
Enum:
{
Azure: No description available. ,
AzureAI: No description available. ,
Database: No description available. ,
NoSQL: No description available. ,
File: No description available. ,
GenericProtocol: No description available. ,
ServicesAndApps: No description available. ,
}
,
Required: False ,
}
enum ,
isSharedToAll:
{
Required: False ,
}
boolean ,
metadata:
{
Description: Store user metadata for this connection ,
Required: False ,
}
object ,
peRequirement:
{
Enum:
{
Required: No description available. ,
NotRequired: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
peStatus:
{
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sharedUserList:
{
Required: False ,
}
[
string ,
]
,
target:
{
Required: False ,
}
string ,
useWorkspaceManagedIdentity:
{
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
authType:
{
Description: Authentication type of the connection target ,
Enum:
{
PAT: No description available. ,
ManagedIdentity: No description available. ,
UsernamePassword: No description available. ,
None: No description available. ,
SAS: No description available. ,
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
AccessKey: No description available. ,
ApiKey: No description available. ,
CustomKeys: No description available. ,
OAuth2: No description available. ,
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
category:
{
Description: Category of the connection ,
Enum:
{
PythonFeed: No description available. ,
ContainerRegistry: No description available. ,
Git: No description available. ,
S3: No description available. ,
Snowflake: No description available. ,
AzureSqlDb: No description available. ,
AzureSynapseAnalytics: No description available. ,
AzureMySqlDb: No description available. ,
AzurePostgresDb: No description available. ,
ADLSGen2: No description available. ,
Redis: No description available. ,
ApiKey: No description available. ,
AzureOpenAI: No description available. ,
AIServices: No description available. ,
CognitiveSearch: No description available. ,
CognitiveService: No description available. ,
CustomKeys: No description available. ,
AzureBlob: No description available. ,
AzureOneLake: No description available. ,
CosmosDb: No description available. ,
CosmosDbMongoDbApi: No description available. ,
AzureDataExplorer: No description available. ,
AzureMariaDb: No description available. ,
AzureDatabricksDeltaLake: No description available. ,
AzureSqlMi: No description available. ,
AzureTableStorage: No description available. ,
AmazonRdsForOracle: No description available. ,
AmazonRdsForSqlServer: No description available. ,
AmazonRedshift: No description available. ,
Db2: No description available. ,
Drill: No description available. ,
GoogleBigQuery: No description available. ,
Greenplum: No description available. ,
Hbase: No description available. ,
Hive: No description available. ,
Impala: No description available. ,
Informix: No description available. ,
MariaDb: No description available. ,
MicrosoftAccess: No description available. ,
MySql: No description available. ,
Netezza: No description available. ,
Oracle: No description available. ,
Phoenix: No description available. ,
PostgreSql: No description available. ,
Presto: No description available. ,
SapOpenHub: No description available. ,
SapBw: No description available. ,
SapHana: No description available. ,
SapTable: No description available. ,
Spark: No description available. ,
SqlServer: No description available. ,
Sybase: No description available. ,
Teradata: No description available. ,
Vertica: No description available. ,
Pinecone: No description available. ,
Cassandra: No description available. ,
Couchbase: No description available. ,
MongoDbV2: No description available. ,
MongoDbAtlas: No description available. ,
AmazonS3Compatible: No description available. ,
FileServer: No description available. ,
FtpServer: No description available. ,
GoogleCloudStorage: No description available. ,
Hdfs: No description available. ,
OracleCloudStorage: No description available. ,
Sftp: No description available. ,
GenericHttp: No description available. ,
ODataRest: No description available. ,
Odbc: No description available. ,
GenericRest: No description available. ,
AmazonMws: No description available. ,
Concur: No description available. ,
Dynamics: No description available. ,
DynamicsAx: No description available. ,
DynamicsCrm: No description available. ,
GoogleAdWords: No description available. ,
Hubspot: No description available. ,
Jira: No description available. ,
Magento: No description available. ,
Marketo: No description available. ,
Office365: No description available. ,
Eloqua: No description available. ,
Responsys: No description available. ,
OracleServiceCloud: No description available. ,
PayPal: No description available. ,
QuickBooks: No description available. ,
Salesforce: No description available. ,
SalesforceServiceCloud: No description available. ,
SalesforceMarketingCloud: No description available. ,
SapCloudForCustomer: No description available. ,
SapEcc: No description available. ,
ServiceNow: No description available. ,
SharePointOnlineList: No description available. ,
Shopify: No description available. ,
Square: No description available. ,
WebTable: No description available. ,
Xero: No description available. ,
Zoho: No description available. ,
GenericContainerRegistry: No description available. ,
Elasticsearch: No description available. ,
OpenAI: No description available. ,
Serp: No description available. ,
BingLLMSearch: No description available. ,
Serverless: No description available. ,
ManagedOnlineEndpoint: No description available. ,
}
,
Required: False ,
}
enum ,
createdByWorkspaceArmId:
{
Format: arm-id ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
expiryTime:
{
Format: date-time ,
Required: False ,
}
string ,
group:
{
Description: Group based on connection category ,
Enum:
{
Azure: No description available. ,
AzureAI: No description available. ,
Database: No description available. ,
NoSQL: No description available. ,
File: No description available. ,
GenericProtocol: No description available. ,
ServicesAndApps: No description available. ,
}
,
Required: False ,
}
enum ,
isSharedToAll:
{
Required: False ,
}
boolean ,
metadata:
{
Description: Store user metadata for this connection ,
Required: False ,
}
object ,
peRequirement:
{
Enum:
{
Required: No description available. ,
NotRequired: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
peStatus:
{
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sharedUserList:
{
Required: False ,
}
[
string ,
]
,
target:
{
Required: False ,
}
string ,
useWorkspaceManagedIdentity:
{
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 ,
}
,
]
,
}
,
}
Connection_ListDeployments (new)
Description :  Get all the deployments under the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
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 ,
}
,
]
,
}
,
}
Connection_DeleteDeployment (new)
Description :  Delete Azure OpenAI connection deployment resource by name
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
deploymentName:
{
Description: Name of the deployment resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
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 (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 ,
}
,
]
,
}
,
}
Connection_GetDeployment (new)
Description :  Get deployments under the Azure OpenAI connection by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
deploymentName:
{
Description: Name of the deployment resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
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 ,
}
,
]
,
}
,
}
Connection_CreateOrUpdateDeployment (new)
Description :  Create or update Azure OpenAI connection deployment resource with the specified parameters
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
deploymentName:
{
Description: Name of the deployment resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
Required: False ,
}
string ,
body:
{
Description: deployment object ,
Required: True ,
}
{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
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 ,
}
,
]
,
}
,
}
WorkspaceConnections_ListSecrets (new)
Description :  List all the secrets of a machine learning workspaces connections.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
authType:
{
Description: Authentication type of the connection target ,
Enum:
{
PAT: No description available. ,
ManagedIdentity: No description available. ,
UsernamePassword: No description available. ,
None: No description available. ,
SAS: No description available. ,
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
AccessKey: No description available. ,
ApiKey: No description available. ,
CustomKeys: No description available. ,
OAuth2: No description available. ,
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
category:
{
Description: Category of the connection ,
Enum:
{
PythonFeed: No description available. ,
ContainerRegistry: No description available. ,
Git: No description available. ,
S3: No description available. ,
Snowflake: No description available. ,
AzureSqlDb: No description available. ,
AzureSynapseAnalytics: No description available. ,
AzureMySqlDb: No description available. ,
AzurePostgresDb: No description available. ,
ADLSGen2: No description available. ,
Redis: No description available. ,
ApiKey: No description available. ,
AzureOpenAI: No description available. ,
AIServices: No description available. ,
CognitiveSearch: No description available. ,
CognitiveService: No description available. ,
CustomKeys: No description available. ,
AzureBlob: No description available. ,
AzureOneLake: No description available. ,
CosmosDb: No description available. ,
CosmosDbMongoDbApi: No description available. ,
AzureDataExplorer: No description available. ,
AzureMariaDb: No description available. ,
AzureDatabricksDeltaLake: No description available. ,
AzureSqlMi: No description available. ,
AzureTableStorage: No description available. ,
AmazonRdsForOracle: No description available. ,
AmazonRdsForSqlServer: No description available. ,
AmazonRedshift: No description available. ,
Db2: No description available. ,
Drill: No description available. ,
GoogleBigQuery: No description available. ,
Greenplum: No description available. ,
Hbase: No description available. ,
Hive: No description available. ,
Impala: No description available. ,
Informix: No description available. ,
MariaDb: No description available. ,
MicrosoftAccess: No description available. ,
MySql: No description available. ,
Netezza: No description available. ,
Oracle: No description available. ,
Phoenix: No description available. ,
PostgreSql: No description available. ,
Presto: No description available. ,
SapOpenHub: No description available. ,
SapBw: No description available. ,
SapHana: No description available. ,
SapTable: No description available. ,
Spark: No description available. ,
SqlServer: No description available. ,
Sybase: No description available. ,
Teradata: No description available. ,
Vertica: No description available. ,
Pinecone: No description available. ,
Cassandra: No description available. ,
Couchbase: No description available. ,
MongoDbV2: No description available. ,
MongoDbAtlas: No description available. ,
AmazonS3Compatible: No description available. ,
FileServer: No description available. ,
FtpServer: No description available. ,
GoogleCloudStorage: No description available. ,
Hdfs: No description available. ,
OracleCloudStorage: No description available. ,
Sftp: No description available. ,
GenericHttp: No description available. ,
ODataRest: No description available. ,
Odbc: No description available. ,
GenericRest: No description available. ,
AmazonMws: No description available. ,
Concur: No description available. ,
Dynamics: No description available. ,
DynamicsAx: No description available. ,
DynamicsCrm: No description available. ,
GoogleAdWords: No description available. ,
Hubspot: No description available. ,
Jira: No description available. ,
Magento: No description available. ,
Marketo: No description available. ,
Office365: No description available. ,
Eloqua: No description available. ,
Responsys: No description available. ,
OracleServiceCloud: No description available. ,
PayPal: No description available. ,
QuickBooks: No description available. ,
Salesforce: No description available. ,
SalesforceServiceCloud: No description available. ,
SalesforceMarketingCloud: No description available. ,
SapCloudForCustomer: No description available. ,
SapEcc: No description available. ,
ServiceNow: No description available. ,
SharePointOnlineList: No description available. ,
Shopify: No description available. ,
Square: No description available. ,
WebTable: No description available. ,
Xero: No description available. ,
Zoho: No description available. ,
GenericContainerRegistry: No description available. ,
Elasticsearch: No description available. ,
OpenAI: No description available. ,
Serp: No description available. ,
BingLLMSearch: No description available. ,
Serverless: No description available. ,
ManagedOnlineEndpoint: No description available. ,
}
,
Required: False ,
}
enum ,
createdByWorkspaceArmId:
{
Format: arm-id ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
expiryTime:
{
Format: date-time ,
Required: False ,
}
string ,
group:
{
Description: Group based on connection category ,
Enum:
{
Azure: No description available. ,
AzureAI: No description available. ,
Database: No description available. ,
NoSQL: No description available. ,
File: No description available. ,
GenericProtocol: No description available. ,
ServicesAndApps: No description available. ,
}
,
Required: False ,
}
enum ,
isSharedToAll:
{
Required: False ,
}
boolean ,
metadata:
{
Description: Store user metadata for this connection ,
Required: False ,
}
object ,
peRequirement:
{
Enum:
{
Required: No description available. ,
NotRequired: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
peStatus:
{
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sharedUserList:
{
Required: False ,
}
[
string ,
]
,
target:
{
Required: False ,
}
string ,
useWorkspaceManagedIdentity:
{
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 ,
}
,
]
,
}
,
}
Connection_GetModels (new)
Description :  Get available models under the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/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 ,
workspaceName:
{
Description: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page constructed using the continuationToken. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: List of models. ,
Required: False ,
}
[
{
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
object ,
deprecation:
{
Required: False ,
}
{
fineTune:
{
Description: The datetime of deprecation of the fineTune Model. ,
Format: date-time ,
Required: False ,
}
string ,
inference:
{
Description: The datetime of deprecation of the inference Model. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
finetuneCapabilities:
{
Description: The capabilities for finetune models. ,
Required: False ,
}
object ,
format:
{
Description: Deployment model format. ,
Required: False ,
}
string ,
isDefaultVersion:
{
Description: If the model is default version. ,
Required: False ,
}
boolean ,
lifecycleStatus:
{
Description: Model lifecycle status. ,
Enum:
{
GenerallyAvailable: No description available. ,
Preview: No description available. ,
}
,
Required: False ,
}
enum ,
maxCapacity:
{
Description: The max capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Deployment model name. ,
Required: False ,
}
string ,
skus:
{
Description: The list of Model Sku. ,
Required: False ,
}
[
{
capacity:
{
Required: False ,
}
{
default:
{
Description: The default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
connectionIds:
{
Description: The list of ARM id for the connection support this SKU. ,
Required: False ,
}
[
string ,
]
,
deprecationDate:
{
Description: The datetime of deprecation of the model SKU. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The name of the model SKU. ,
Required: False ,
}
string ,
rateLimits:
{
Required: False ,
}
[
{
count:
{
Description: The count value of Call Rate Limit. ,
Format: float ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Format: float ,
Required: False ,
}
number ,
rules:
{
Description: The call rate limit for the model. ,
Required: False ,
}
[
{
count:
{
Format: float ,
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Description: If the dynamic throttling is enabled. ,
Required: False ,
}
boolean ,
key:
{
Required: False ,
}
string ,
matchPatterns:
{
Required: False ,
}
[
{
method:
{
Required: False ,
}
string ,
path:
{
Required: False ,
}
string ,
}
,
]
,
minCount:
{
Format: float ,
Required: False ,
}
number ,
renewalPeriod:
{
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
usageName:
{
Description: The usage name of the model SKU. ,
Required: False ,
}
string ,
}
,
]
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
version:
{
Description: Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API. ,
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 ,
}
,
]
,
}
,
}
ConnectionRaiBlocklists_List (new)
Description :  Gets the custom blocklists associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiBlocklists
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Description: RAI Custom Blocklist properties. ,
Required: True ,
}
{
description:
{
Description: Description of the block 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 ,
}
,
]
,
}
,
}
ConnectionRaiBlocklist_Delete (new)
Description :  Deletes the specified custom blocklist associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiBlocklists/{raiBlocklistName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
raiBlocklistName:
{
Description: The name of the RaiBlocklist. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
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 (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 ,
}
,
]
,
}
,
}
ConnectionRaiBlocklist_Get (new)
Description :  Gets the specified custom blocklist associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiBlocklists/{raiBlocklistName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
raiBlocklistName:
{
Description: The name of the RaiBlocklist. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: RAI Custom Blocklist properties. ,
Required: True ,
}
{
description:
{
Description: Description of the block 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 ,
}
,
]
,
}
,
}
ConnectionRaiBlocklist_Create (new)
Description :  Update the state of specified blocklist associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiBlocklists/{raiBlocklistName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
raiBlocklistName:
{
Description: The name of the RaiBlocklist. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
properties:
{
Description: RAI Custom Blocklist properties. ,
Required: True ,
}
{
description:
{
Description: Description of the block list. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: RAI Custom Blocklist properties. ,
Required: True ,
}
{
description:
{
Description: Description of the block list. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: RAI Custom Blocklist properties. ,
Required: True ,
}
{
description:
{
Description: Description of the block 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 ,
}
,
]
,
}
,
}
ConnectionRaiBlocklistItem_AddBulk (new)
Description :  Add multiple blocklist items to the specified blocklist associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiBlocklists/{raiBlocklistName}/addRaiBlocklistItems
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
raiBlocklistName:
{
Description: The name of the RaiBlocklist. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Properties describing the custom blocklist items. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
properties:
{
Description: Properties of Cognitive Services RaiBlocklist Item. ,
Required: False ,
}
{
isRegex:
{
Description: If the pattern is a regex pattern. ,
Required: False ,
}
boolean ,
pattern:
{
Description: Pattern to match against. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: RAI Custom Blocklist Item properties. ,
Required: True ,
}
{
isRegex:
{
Description: If the pattern is a regex pattern. ,
Required: False ,
}
boolean ,
pattern:
{
Description: Pattern to match against. ,
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 ,
}
,
]
,
}
,
}
ConnectionRaiBlocklistItem_DeleteBulk (new)
Description :  Delete multiple blocklist items from the specified blocklist associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiBlocklists/{raiBlocklistName}/deleteRaiBlocklistItems
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
raiBlocklistName:
{
Description: The name of the RaiBlocklist. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: List of RAI Blocklist Items Names. ,
Required: True ,
}
object ,
}

⚐ 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 (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 ,
}
,
]
,
}
,
}
ConnectionRaiBlocklistItems_List (new)
Description :  Gets the custom blocklist items associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
raiBlocklistName:
{
Description: The name of the RaiBlocklist. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Description: RAI Custom Blocklist Item properties. ,
Required: True ,
}
{
isRegex:
{
Description: If the pattern is a regex pattern. ,
Required: False ,
}
boolean ,
pattern:
{
Description: Pattern to match against. ,
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 ,
}
,
]
,
}
,
}
ConnectionRaiBlocklistItem_Delete (new)
Description :  Deletes the specified custom blocklist item associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems/{raiBlocklistItemName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
raiBlocklistName:
{
Description: The name of the RaiBlocklist. ,
Required: True ,
}
string ,
raiBlocklistItemName:
{
Description: Name of the RaiBlocklist Item ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
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 (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 ,
}
,
]
,
}
,
}
ConnectionRaiBlocklistItem_Get (new)
Description :  Gets the specified custom blocklist item associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems/{raiBlocklistItemName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
raiBlocklistName:
{
Description: The name of the RaiBlocklist. ,
Required: True ,
}
string ,
raiBlocklistItemName:
{
Description: Name of the RaiBlocklist Item ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: RAI Custom Blocklist Item properties. ,
Required: True ,
}
{
isRegex:
{
Description: If the pattern is a regex pattern. ,
Required: False ,
}
boolean ,
pattern:
{
Description: Pattern to match against. ,
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 ,
}
,
]
,
}
,
}
ConnectionRaiBlocklistItem_Create (new)
Description :  Update the state of specified blocklist item associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiBlocklists/{raiBlocklistName}/raiBlocklistItems/{raiBlocklistItemName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
raiBlocklistName:
{
Description: The name of the RaiBlocklist. ,
Required: True ,
}
string ,
raiBlocklistItemName:
{
Description: Name of the RaiBlocklist Item ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
properties:
{
Description: RAI Custom Blocklist Item properties. ,
Required: True ,
}
{
isRegex:
{
Description: If the pattern is a regex pattern. ,
Required: False ,
}
boolean ,
pattern:
{
Description: Pattern to match against. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: RAI Custom Blocklist Item properties. ,
Required: True ,
}
{
isRegex:
{
Description: If the pattern is a regex pattern. ,
Required: False ,
}
boolean ,
pattern:
{
Description: Pattern to match against. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: RAI Custom Blocklist Item properties. ,
Required: True ,
}
{
isRegex:
{
Description: If the pattern is a regex pattern. ,
Required: False ,
}
boolean ,
pattern:
{
Description: Pattern to match against. ,
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 ,
}
,
]
,
}
,
}
ConnectionRaiPolicies_List (new)
Description :  List the specified Content Filters associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiPolicies
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Description: Azure OpenAI Content Filters properties. ,
Required: True ,
}
{
basePolicyName:
{
Description: Name of the base Content Filters. ,
Required: False ,
}
string ,
completionBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
contentFilters:
{
Required: False ,
}
[
{
allowedContentLevel:
{
Description: Level at which content is filtered. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the ContentFilter is enabled. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
source:
{
Description: Content source to apply the Content Filters. ,
Enum:
{
Prompt: No description available. ,
Completion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
mode:
{
Description: Content Filters mode. ,
Enum:
{
Default: No description available. ,
Deferred: No description available. ,
Blocking: No description available. ,
}
,
Required: False ,
}
enum ,
promptBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Content Filters policy type. ,
Enum:
{
UserManaged: No description available. ,
SystemManaged: 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 ,
}
,
]
,
}
,
}
ConnectionRaiPolicy_Delete (new)
Description :  Deletes the specified Content Filters associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiPolicies/{raiPolicyName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
raiPolicyName:
{
Description: Name of the Rai Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
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 (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 ,
}
,
]
,
}
,
}
ConnectionRaiPolicy_Get (new)
Description :  Gets the specified Content Filters associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiPolicies/{raiPolicyName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
raiPolicyName:
{
Description: Name of the Rai Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Azure OpenAI Content Filters properties. ,
Required: True ,
}
{
basePolicyName:
{
Description: Name of the base Content Filters. ,
Required: False ,
}
string ,
completionBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
contentFilters:
{
Required: False ,
}
[
{
allowedContentLevel:
{
Description: Level at which content is filtered. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the ContentFilter is enabled. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
source:
{
Description: Content source to apply the Content Filters. ,
Enum:
{
Prompt: No description available. ,
Completion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
mode:
{
Description: Content Filters mode. ,
Enum:
{
Default: No description available. ,
Deferred: No description available. ,
Blocking: No description available. ,
}
,
Required: False ,
}
enum ,
promptBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Content Filters policy type. ,
Enum:
{
UserManaged: No description available. ,
SystemManaged: 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 ,
}
,
]
,
}
,
}
ConnectionRaiPolicy_Create (new)
Description :  Update the state of specified Content Filters associated with the Azure OpenAI connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/raiPolicies/{raiPolicyName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
raiPolicyName:
{
Description: Name of the Rai Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
properties:
{
Description: Azure OpenAI Content Filters properties. ,
Required: True ,
}
{
basePolicyName:
{
Description: Name of the base Content Filters. ,
Required: False ,
}
string ,
completionBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
contentFilters:
{
Required: False ,
}
[
{
allowedContentLevel:
{
Description: Level at which content is filtered. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the ContentFilter is enabled. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
source:
{
Description: Content source to apply the Content Filters. ,
Enum:
{
Prompt: No description available. ,
Completion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
mode:
{
Description: Content Filters mode. ,
Enum:
{
Default: No description available. ,
Deferred: No description available. ,
Blocking: No description available. ,
}
,
Required: False ,
}
enum ,
promptBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Content Filters policy type. ,
Enum:
{
UserManaged: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Azure OpenAI Content Filters properties. ,
Required: True ,
}
{
basePolicyName:
{
Description: Name of the base Content Filters. ,
Required: False ,
}
string ,
completionBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
contentFilters:
{
Required: False ,
}
[
{
allowedContentLevel:
{
Description: Level at which content is filtered. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the ContentFilter is enabled. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
source:
{
Description: Content source to apply the Content Filters. ,
Enum:
{
Prompt: No description available. ,
Completion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
mode:
{
Description: Content Filters mode. ,
Enum:
{
Default: No description available. ,
Deferred: No description available. ,
Blocking: No description available. ,
}
,
Required: False ,
}
enum ,
promptBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Content Filters policy type. ,
Enum:
{
UserManaged: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Azure OpenAI Content Filters properties. ,
Required: True ,
}
{
basePolicyName:
{
Description: Name of the base Content Filters. ,
Required: False ,
}
string ,
completionBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
contentFilters:
{
Required: False ,
}
[
{
allowedContentLevel:
{
Description: Level at which content is filtered. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the ContentFilter is enabled. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
source:
{
Description: Content source to apply the Content Filters. ,
Enum:
{
Prompt: No description available. ,
Completion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
mode:
{
Description: Content Filters mode. ,
Enum:
{
Default: No description available. ,
Deferred: No description available. ,
Blocking: No description available. ,
}
,
Required: False ,
}
enum ,
promptBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Content Filters policy type. ,
Enum:
{
UserManaged: No description available. ,
SystemManaged: 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 ,
}
,
]
,
}
,
}
WorkspaceConnections_TestConnection (new)
Description :  Test machine learning workspaces connections under the specified workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/testconnection
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
connectionName:
{
Description: Friendly name of the workspace connection ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Workspace Connection object ,
Required: False ,
}
{
properties:
{
Required: True ,
}
{
authType:
{
Description: Authentication type of the connection target ,
Enum:
{
PAT: No description available. ,
ManagedIdentity: No description available. ,
UsernamePassword: No description available. ,
None: No description available. ,
SAS: No description available. ,
AccountKey: No description available. ,
ServicePrincipal: No description available. ,
AccessKey: No description available. ,
ApiKey: No description available. ,
CustomKeys: No description available. ,
OAuth2: No description available. ,
AAD: No description available. ,
}
,
Required: True ,
}
enum ,
category:
{
Description: Category of the connection ,
Enum:
{
PythonFeed: No description available. ,
ContainerRegistry: No description available. ,
Git: No description available. ,
S3: No description available. ,
Snowflake: No description available. ,
AzureSqlDb: No description available. ,
AzureSynapseAnalytics: No description available. ,
AzureMySqlDb: No description available. ,
AzurePostgresDb: No description available. ,
ADLSGen2: No description available. ,
Redis: No description available. ,
ApiKey: No description available. ,
AzureOpenAI: No description available. ,
AIServices: No description available. ,
CognitiveSearch: No description available. ,
CognitiveService: No description available. ,
CustomKeys: No description available. ,
AzureBlob: No description available. ,
AzureOneLake: No description available. ,
CosmosDb: No description available. ,
CosmosDbMongoDbApi: No description available. ,
AzureDataExplorer: No description available. ,
AzureMariaDb: No description available. ,
AzureDatabricksDeltaLake: No description available. ,
AzureSqlMi: No description available. ,
AzureTableStorage: No description available. ,
AmazonRdsForOracle: No description available. ,
AmazonRdsForSqlServer: No description available. ,
AmazonRedshift: No description available. ,
Db2: No description available. ,
Drill: No description available. ,
GoogleBigQuery: No description available. ,
Greenplum: No description available. ,
Hbase: No description available. ,
Hive: No description available. ,
Impala: No description available. ,
Informix: No description available. ,
MariaDb: No description available. ,
MicrosoftAccess: No description available. ,
MySql: No description available. ,
Netezza: No description available. ,
Oracle: No description available. ,
Phoenix: No description available. ,
PostgreSql: No description available. ,
Presto: No description available. ,
SapOpenHub: No description available. ,
SapBw: No description available. ,
SapHana: No description available. ,
SapTable: No description available. ,
Spark: No description available. ,
SqlServer: No description available. ,
Sybase: No description available. ,
Teradata: No description available. ,
Vertica: No description available. ,
Pinecone: No description available. ,
Cassandra: No description available. ,
Couchbase: No description available. ,
MongoDbV2: No description available. ,
MongoDbAtlas: No description available. ,
AmazonS3Compatible: No description available. ,
FileServer: No description available. ,
FtpServer: No description available. ,
GoogleCloudStorage: No description available. ,
Hdfs: No description available. ,
OracleCloudStorage: No description available. ,
Sftp: No description available. ,
GenericHttp: No description available. ,
ODataRest: No description available. ,
Odbc: No description available. ,
GenericRest: No description available. ,
AmazonMws: No description available. ,
Concur: No description available. ,
Dynamics: No description available. ,
DynamicsAx: No description available. ,
DynamicsCrm: No description available. ,
GoogleAdWords: No description available. ,
Hubspot: No description available. ,
Jira: No description available. ,
Magento: No description available. ,
Marketo: No description available. ,
Office365: No description available. ,
Eloqua: No description available. ,
Responsys: No description available. ,
OracleServiceCloud: No description available. ,
PayPal: No description available. ,
QuickBooks: No description available. ,
Salesforce: No description available. ,
SalesforceServiceCloud: No description available. ,
SalesforceMarketingCloud: No description available. ,
SapCloudForCustomer: No description available. ,
SapEcc: No description available. ,
ServiceNow: No description available. ,
SharePointOnlineList: No description available. ,
Shopify: No description available. ,
Square: No description available. ,
WebTable: No description available. ,
Xero: No description available. ,
Zoho: No description available. ,
GenericContainerRegistry: No description available. ,
Elasticsearch: No description available. ,
OpenAI: No description available. ,
Serp: No description available. ,
BingLLMSearch: No description available. ,
Serverless: No description available. ,
ManagedOnlineEndpoint: No description available. ,
}
,
Required: False ,
}
enum ,
createdByWorkspaceArmId:
{
Format: arm-id ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
string ,
expiryTime:
{
Format: date-time ,
Required: False ,
}
string ,
group:
{
Description: Group based on connection category ,
Enum:
{
Azure: No description available. ,
AzureAI: No description available. ,
Database: No description available. ,
NoSQL: No description available. ,
File: No description available. ,
GenericProtocol: No description available. ,
ServicesAndApps: No description available. ,
}
,
Required: False ,
}
enum ,
isSharedToAll:
{
Required: False ,
}
boolean ,
metadata:
{
Description: Store user metadata for this connection ,
Required: False ,
}
object ,
peRequirement:
{
Enum:
{
Required: No description available. ,
NotRequired: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
peStatus:
{
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sharedUserList:
{
Required: False ,
}
[
string ,
]
,
target:
{
Required: False ,
}
string ,
useWorkspaceManagedIdentity:
{
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
EndpointDeployment_GetInWorkspace (new)
Description :  Get all the deployments under the workspace scope
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
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 ,
}
,
]
,
}
,
}
Workspaces_Diagnose (new)
Description :  Diagnose workspace setup issue.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The parameter of diagnosing workspace health ,
Required: False ,
}
{
value:
{
Required: False ,
}
{
applicationInsights:
{
Description: Setting for diagnosing dependent application insights ,
Required: False ,
}
object ,
containerRegistry:
{
Description: Setting for diagnosing dependent container registry ,
Required: False ,
}
object ,
dnsResolution:
{
Description: Setting for diagnosing dns resolution ,
Required: False ,
}
object ,
keyVault:
{
Description: Setting for diagnosing dependent key vault ,
Required: False ,
}
object ,
nsg:
{
Description: Setting for diagnosing network security group ,
Required: False ,
}
object ,
others:
{
Description: Setting for diagnosing unclassified category of problems ,
Required: False ,
}
object ,
requiredResourceProviders:
{
Description: Setting for diagnosing the presence of required resource providers in the workspace. ,
Required: False ,
}
object ,
resourceLock:
{
Description: Setting for diagnosing resource lock ,
Required: False ,
}
object ,
storageAccount:
{
Description: Setting for diagnosing dependent storage account ,
Required: False ,
}
object ,
udr:
{
Description: Setting for diagnosing user defined routing ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
{
userDefinedRouteResults:
{
Required: False ,
}
[
{
code:
{
Description: Code for workspace setup error ,
Required: False ,
}
string ,
level:
{
Description: Level of workspace setup error ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message of workspace setup error ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityRuleResults:
{
Required: False ,
}
[
{
code:
{
Description: Code for workspace setup error ,
Required: False ,
}
string ,
level:
{
Description: Level of workspace setup error ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message of workspace setup error ,
Required: False ,
}
string ,
}
,
]
,
resourceLockResults:
{
Required: False ,
}
[
{
code:
{
Description: Code for workspace setup error ,
Required: False ,
}
string ,
level:
{
Description: Level of workspace setup error ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message of workspace setup error ,
Required: False ,
}
string ,
}
,
]
,
dnsResolutionResults:
{
Required: False ,
}
[
{
code:
{
Description: Code for workspace setup error ,
Required: False ,
}
string ,
level:
{
Description: Level of workspace setup error ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message of workspace setup error ,
Required: False ,
}
string ,
}
,
]
,
storageAccountResults:
{
Required: False ,
}
[
{
code:
{
Description: Code for workspace setup error ,
Required: False ,
}
string ,
level:
{
Description: Level of workspace setup error ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message of workspace setup error ,
Required: False ,
}
string ,
}
,
]
,
keyVaultResults:
{
Required: False ,
}
[
{
code:
{
Description: Code for workspace setup error ,
Required: False ,
}
string ,
level:
{
Description: Level of workspace setup error ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message of workspace setup error ,
Required: False ,
}
string ,
}
,
]
,
containerRegistryResults:
{
Required: False ,
}
[
{
code:
{
Description: Code for workspace setup error ,
Required: False ,
}
string ,
level:
{
Description: Level of workspace setup error ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message of workspace setup error ,
Required: False ,
}
string ,
}
,
]
,
applicationInsightsResults:
{
Required: False ,
}
[
{
code:
{
Description: Code for workspace setup error ,
Required: False ,
}
string ,
level:
{
Description: Level of workspace setup error ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message of workspace setup error ,
Required: False ,
}
string ,
}
,
]
,
otherResults:
{
Required: False ,
}
[
{
code:
{
Description: Code for workspace setup error ,
Required: False ,
}
string ,
level:
{
Description: Level of workspace setup error ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Message of workspace setup error ,
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 ,
}
,
]
,
}
,
}
Endpoint_List (new)
Description :  List All the endpoints under this workspace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
endpointType:
{
Description: Endpoint type filter ,
Required: False ,
}
string ,
includeOnlineEndpoints:
{
Required: False ,
}
boolean ,
includeServerlessEndpoints:
{
Required: False ,
}
boolean ,
includeConnections:
{
Required: False ,
}
boolean ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
$expand:
{
Description: Whether the endpoint resource will be expand to include deployment information, e.g. $expand=deployments ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
associatedResourceId:
{
Description: Byo resource id for creating the built-in model service endpoints. ,
Format: arm-id ,
Required: False ,
}
string ,
deployments:
{
Description: Deployments info. ,
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
Required: True ,
}
string ,
}
,
}
,
]
,
endpointType:
{
Description: Type of the endpoint. ,
Enum:
{
Azure.OpenAI: No description available. ,
Azure.Speech: No description available. ,
Azure.ContentSafety: No description available. ,
Azure.Llama: No description available. ,
managedOnlineEndpoint: No description available. ,
serverlessEndpoint: No description available. ,
}
,
Required: True ,
}
enum ,
endpointUri:
{
Description: Uri of the endpoint. ,
Format: url ,
Required: False ,
}
string ,
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
location:
{
Description: Location of the endpoint. Since input dto and when parse endpoint resource share the same contract this Location field is just for parse the endpoint resource info we won't let customer specify the endpoint resource location since we will create it the same location as workspace ,
Required: False ,
}
string ,
name:
{
Description: Name of the endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
shouldCreateAiServicesEndpoint:
{
Description: Whether the proxy (non-byo) endpoint is a regular endpoint or a OneKeyV2 AI services account endpoint. ,
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 ,
}
,
]
,
}
,
}
Endpoint_Get (new)
Description :  Gets endpoint resource
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
associatedResourceId:
{
Description: Byo resource id for creating the built-in model service endpoints. ,
Format: arm-id ,
Required: False ,
}
string ,
deployments:
{
Description: Deployments info. ,
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
Required: True ,
}
string ,
}
,
}
,
]
,
endpointType:
{
Description: Type of the endpoint. ,
Enum:
{
Azure.OpenAI: No description available. ,
Azure.Speech: No description available. ,
Azure.ContentSafety: No description available. ,
Azure.Llama: No description available. ,
managedOnlineEndpoint: No description available. ,
serverlessEndpoint: No description available. ,
}
,
Required: True ,
}
enum ,
endpointUri:
{
Description: Uri of the endpoint. ,
Format: url ,
Required: False ,
}
string ,
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
location:
{
Description: Location of the endpoint. Since input dto and when parse endpoint resource share the same contract this Location field is just for parse the endpoint resource info we won't let customer specify the endpoint resource location since we will create it the same location as workspace ,
Required: False ,
}
string ,
name:
{
Description: Name of the endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
shouldCreateAiServicesEndpoint:
{
Description: Whether the proxy (non-byo) endpoint is a regular endpoint or a OneKeyV2 AI services account endpoint. ,
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 ,
}
,
]
,
}
,
}
Endpoint_CreateOrUpdate (new)
Description :  Create or update endpoint resource with the specified parameters
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Endpoint resource object ,
Required: True ,
}
{
properties:
{
Required: True ,
}
{
associatedResourceId:
{
Description: Byo resource id for creating the built-in model service endpoints. ,
Format: arm-id ,
Required: False ,
}
string ,
deployments:
{
Description: Deployments info. ,
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
Required: True ,
}
string ,
}
,
}
,
]
,
endpointType:
{
Description: Type of the endpoint. ,
Enum:
{
Azure.OpenAI: No description available. ,
Azure.Speech: No description available. ,
Azure.ContentSafety: No description available. ,
Azure.Llama: No description available. ,
managedOnlineEndpoint: No description available. ,
serverlessEndpoint: No description available. ,
}
,
Required: True ,
}
enum ,
endpointUri:
{
Description: Uri of the endpoint. ,
Format: url ,
Required: False ,
}
string ,
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
location:
{
Description: Location of the endpoint. Since input dto and when parse endpoint resource share the same contract this Location field is just for parse the endpoint resource info we won't let customer specify the endpoint resource location since we will create it the same location as workspace ,
Required: False ,
}
string ,
name:
{
Description: Name of the endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
shouldCreateAiServicesEndpoint:
{
Description: Whether the proxy (non-byo) endpoint is a regular endpoint or a OneKeyV2 AI services account endpoint. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
associatedResourceId:
{
Description: Byo resource id for creating the built-in model service endpoints. ,
Format: arm-id ,
Required: False ,
}
string ,
deployments:
{
Description: Deployments info. ,
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
Required: True ,
}
string ,
}
,
}
,
]
,
endpointType:
{
Description: Type of the endpoint. ,
Enum:
{
Azure.OpenAI: No description available. ,
Azure.Speech: No description available. ,
Azure.ContentSafety: No description available. ,
Azure.Llama: No description available. ,
managedOnlineEndpoint: No description available. ,
serverlessEndpoint: No description available. ,
}
,
Required: True ,
}
enum ,
endpointUri:
{
Description: Uri of the endpoint. ,
Format: url ,
Required: False ,
}
string ,
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
location:
{
Description: Location of the endpoint. Since input dto and when parse endpoint resource share the same contract this Location field is just for parse the endpoint resource info we won't let customer specify the endpoint resource location since we will create it the same location as workspace ,
Required: False ,
}
string ,
name:
{
Description: Name of the endpoint. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
shouldCreateAiServicesEndpoint:
{
Description: Whether the proxy (non-byo) endpoint is a regular endpoint or a OneKeyV2 AI services account endpoint. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
EndpointDeployment_List (new)
Description :  Get all the deployments under the endpoint resource scope
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
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 ,
}
,
]
,
}
,
}
EndpointDeployment_Delete (new)
Description :  Delete endpoint deployment resource by name
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint resource. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Name of the deployment resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
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 (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 ,
}
,
]
,
}
,
}
EndpointDeployment_Get (new)
Description :  Get deployments under endpoint resource by name
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
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 ,
}
,
]
,
}
,
}
EndpointDeployment_CreateOrUpdate (new)
Description :  Create or update endpoint deployment resource with the specified parameters
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint resource. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Name of the deployment resource ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: deployment object ,
Required: True ,
}
{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: True ,
}
{
failureReason:
{
Description: The failure reason if the creation failed. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Read-only provision state status property. ,
Enum:
{
NotStarted: No description available. ,
Failed: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Canceled: No description available. ,
Scaling: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Kind of the deployment. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
Endpoint_ListKeys (new)
Description :  List keys for the endpoint resource.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
keys:
{
Description: Dictionary of Keys for the endpoint. ,
Required: False ,
}
{
key1:
{
Required: False ,
}
string ,
key2:
{
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 ,
}
,
]
,
}
,
}
Endpoint_GetModels (new)
Description :  Get available models under the endpoint resource.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page constructed using the continuationToken. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: List of models. ,
Required: False ,
}
[
{
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
object ,
deprecation:
{
Required: False ,
}
{
fineTune:
{
Description: The datetime of deprecation of the fineTune Model. ,
Format: date-time ,
Required: False ,
}
string ,
inference:
{
Description: The datetime of deprecation of the inference Model. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
finetuneCapabilities:
{
Description: The capabilities for finetune models. ,
Required: False ,
}
object ,
format:
{
Description: Deployment model format. ,
Required: False ,
}
string ,
isDefaultVersion:
{
Description: If the model is default version. ,
Required: False ,
}
boolean ,
lifecycleStatus:
{
Description: Model lifecycle status. ,
Enum:
{
GenerallyAvailable: No description available. ,
Preview: No description available. ,
}
,
Required: False ,
}
enum ,
maxCapacity:
{
Description: The max capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Deployment model name. ,
Required: False ,
}
string ,
skus:
{
Description: The list of Model Sku. ,
Required: False ,
}
[
{
capacity:
{
Required: False ,
}
{
default:
{
Description: The default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
connectionIds:
{
Description: The list of ARM id for the connection support this SKU. ,
Required: False ,
}
[
string ,
]
,
deprecationDate:
{
Description: The datetime of deprecation of the model SKU. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The name of the model SKU. ,
Required: False ,
}
string ,
rateLimits:
{
Required: False ,
}
[
{
count:
{
Description: The count value of Call Rate Limit. ,
Format: float ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Format: float ,
Required: False ,
}
number ,
rules:
{
Description: The call rate limit for the model. ,
Required: False ,
}
[
{
count:
{
Format: float ,
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Description: If the dynamic throttling is enabled. ,
Required: False ,
}
boolean ,
key:
{
Required: False ,
}
string ,
matchPatterns:
{
Required: False ,
}
[
{
method:
{
Required: False ,
}
string ,
path:
{
Required: False ,
}
string ,
}
,
]
,
minCount:
{
Format: float ,
Required: False ,
}
number ,
renewalPeriod:
{
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
usageName:
{
Description: The usage name of the model SKU. ,
Required: False ,
}
string ,
}
,
]
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
version:
{
Description: Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API. ,
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 ,
}
,
]
,
}
,
}
RaiPolicies_List (new)
Description :  List the specified Content Filters associated with the Azure OpenAI account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/raiPolicies
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Description: Azure OpenAI Content Filters properties. ,
Required: True ,
}
{
basePolicyName:
{
Description: Name of the base Content Filters. ,
Required: False ,
}
string ,
completionBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
contentFilters:
{
Required: False ,
}
[
{
allowedContentLevel:
{
Description: Level at which content is filtered. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the ContentFilter is enabled. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
source:
{
Description: Content source to apply the Content Filters. ,
Enum:
{
Prompt: No description available. ,
Completion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
mode:
{
Description: Content Filters mode. ,
Enum:
{
Default: No description available. ,
Deferred: No description available. ,
Blocking: No description available. ,
}
,
Required: False ,
}
enum ,
promptBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Content Filters policy type. ,
Enum:
{
UserManaged: No description available. ,
SystemManaged: 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 ,
}
,
]
,
}
,
}
RaiPolicy_Delete (new)
Description :  Deletes the specified Content Filters associated with the Azure OpenAI account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/raiPolicies/{raiPolicyName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint resource. ,
Required: True ,
}
string ,
raiPolicyName:
{
Description: Name of the Rai Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
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 (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 ,
}
,
]
,
}
,
}
RaiPolicy_Get (new)
Description :  Gets the specified Content Filters associated with the Azure OpenAI account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/raiPolicies/{raiPolicyName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint resource. ,
Required: True ,
}
string ,
raiPolicyName:
{
Description: Name of the Rai Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Azure OpenAI Content Filters properties. ,
Required: True ,
}
{
basePolicyName:
{
Description: Name of the base Content Filters. ,
Required: False ,
}
string ,
completionBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
contentFilters:
{
Required: False ,
}
[
{
allowedContentLevel:
{
Description: Level at which content is filtered. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the ContentFilter is enabled. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
source:
{
Description: Content source to apply the Content Filters. ,
Enum:
{
Prompt: No description available. ,
Completion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
mode:
{
Description: Content Filters mode. ,
Enum:
{
Default: No description available. ,
Deferred: No description available. ,
Blocking: No description available. ,
}
,
Required: False ,
}
enum ,
promptBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Content Filters policy type. ,
Enum:
{
UserManaged: No description available. ,
SystemManaged: 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 ,
}
,
]
,
}
,
}
RaiPolicy_Create (new)
Description :  Update the state of specified Content Filters associated with the Azure OpenAI account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/raiPolicies/{raiPolicyName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint resource. ,
Required: True ,
}
string ,
raiPolicyName:
{
Description: Name of the Rai Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
proxy-api-version:
{
Description: Api version used by proxy call ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
properties:
{
Description: Azure OpenAI Content Filters properties. ,
Required: True ,
}
{
basePolicyName:
{
Description: Name of the base Content Filters. ,
Required: False ,
}
string ,
completionBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
contentFilters:
{
Required: False ,
}
[
{
allowedContentLevel:
{
Description: Level at which content is filtered. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the ContentFilter is enabled. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
source:
{
Description: Content source to apply the Content Filters. ,
Enum:
{
Prompt: No description available. ,
Completion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
mode:
{
Description: Content Filters mode. ,
Enum:
{
Default: No description available. ,
Deferred: No description available. ,
Blocking: No description available. ,
}
,
Required: False ,
}
enum ,
promptBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Content Filters policy type. ,
Enum:
{
UserManaged: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Azure OpenAI Content Filters properties. ,
Required: True ,
}
{
basePolicyName:
{
Description: Name of the base Content Filters. ,
Required: False ,
}
string ,
completionBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
contentFilters:
{
Required: False ,
}
[
{
allowedContentLevel:
{
Description: Level at which content is filtered. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the ContentFilter is enabled. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
source:
{
Description: Content source to apply the Content Filters. ,
Enum:
{
Prompt: No description available. ,
Completion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
mode:
{
Description: Content Filters mode. ,
Enum:
{
Default: No description available. ,
Deferred: No description available. ,
Blocking: No description available. ,
}
,
Required: False ,
}
enum ,
promptBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Content Filters policy type. ,
Enum:
{
UserManaged: No description available. ,
SystemManaged: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Azure OpenAI Content Filters properties. ,
Required: True ,
}
{
basePolicyName:
{
Description: Name of the base Content Filters. ,
Required: False ,
}
string ,
completionBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
contentFilters:
{
Required: False ,
}
[
{
allowedContentLevel:
{
Description: Level at which content is filtered. ,
Enum:
{
Low: No description available. ,
Medium: No description available. ,
High: No description available. ,
}
,
Required: False ,
}
enum ,
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
enabled:
{
Description: If the ContentFilter is enabled. ,
Required: False ,
}
boolean ,
name:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
source:
{
Description: Content source to apply the Content Filters. ,
Enum:
{
Prompt: No description available. ,
Completion: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
mode:
{
Description: Content Filters mode. ,
Enum:
{
Default: No description available. ,
Deferred: No description available. ,
Blocking: No description available. ,
}
,
Required: False ,
}
enum ,
promptBlocklists:
{
Required: False ,
}
[
{
blocking:
{
Description: If blocking would occur. ,
Required: False ,
}
boolean ,
blocklistName:
{
Description: Name of ContentFilter. ,
Required: False ,
}
string ,
}
,
]
,
type:
{
Description: Content Filters policy type. ,
Enum:
{
UserManaged: No description available. ,
SystemManaged: 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 ,
}
,
]
,
}
,
}
Endpoint_RegenerateKeys (new)
Description :  Regenerate account keys
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints/{endpointName}/regenerateKey
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
keyName:
{
Enum:
{
Key1: No description available. ,
Key2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
key1:
{
Required: False ,
}
string ,
key2:
{
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 ,
}
,
]
,
}
,
}
Connection_GetAllModels (new)
Description :  Get models under the Azure ML workspace for all Azure OpenAI connections that the user can deploy.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page constructed using the continuationToken. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: List of models. ,
Required: False ,
}
[
{
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
object ,
deprecation:
{
Required: False ,
}
{
fineTune:
{
Description: The datetime of deprecation of the fineTune Model. ,
Format: date-time ,
Required: False ,
}
string ,
inference:
{
Description: The datetime of deprecation of the inference Model. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
finetuneCapabilities:
{
Description: The capabilities for finetune models. ,
Required: False ,
}
object ,
format:
{
Description: Deployment model format. ,
Required: False ,
}
string ,
isDefaultVersion:
{
Description: If the model is default version. ,
Required: False ,
}
boolean ,
lifecycleStatus:
{
Description: Model lifecycle status. ,
Enum:
{
GenerallyAvailable: No description available. ,
Preview: No description available. ,
}
,
Required: False ,
}
enum ,
maxCapacity:
{
Description: The max capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Deployment model name. ,
Required: False ,
}
string ,
skus:
{
Description: The list of Model Sku. ,
Required: False ,
}
[
{
capacity:
{
Required: False ,
}
{
default:
{
Description: The default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
connectionIds:
{
Description: The list of ARM id for the connection support this SKU. ,
Required: False ,
}
[
string ,
]
,
deprecationDate:
{
Description: The datetime of deprecation of the model SKU. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The name of the model SKU. ,
Required: False ,
}
string ,
rateLimits:
{
Required: False ,
}
[
{
count:
{
Description: The count value of Call Rate Limit. ,
Format: float ,
Required: False ,
}
number ,
renewalPeriod:
{
Description: The renewal period in seconds of Call Rate Limit. ,
Format: float ,
Required: False ,
}
number ,
rules:
{
Description: The call rate limit for the model. ,
Required: False ,
}
[
{
count:
{
Format: float ,
Required: False ,
}
number ,
dynamicThrottlingEnabled:
{
Description: If the dynamic throttling is enabled. ,
Required: False ,
}
boolean ,
key:
{
Required: False ,
}
string ,
matchPatterns:
{
Required: False ,
}
[
{
method:
{
Required: False ,
}
string ,
path:
{
Required: False ,
}
string ,
}
,
]
,
minCount:
{
Format: float ,
Required: False ,
}
number ,
renewalPeriod:
{
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
usageName:
{
Description: The usage name of the model SKU. ,
Required: False ,
}
string ,
}
,
]
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
version:
{
Description: Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API. ,
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 ,
}
,
]
,
}
,
}
Workspaces_ListKeys (new)
Description :  Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
appInsightsInstrumentationKey:
{
Description: The access key of the workspace app insights ,
Required: False ,
}
string ,
containerRegistryCredentials:
{
Required: False ,
}
{
location:
{
Description: The location of the workspace ACR ,
Required: False ,
}
string ,
passwords:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
username:
{
Description: The username of the workspace ACR ,
Required: False ,
}
string ,
}
,
notebookAccessKeys:
{
Required: False ,
}
{
primaryAccessKey:
{
Description: The primary access key of the Notebook ,
Required: False ,
}
string ,
secondaryAccessKey:
{
Description: The secondary access key of the Notebook ,
Required: False ,
}
string ,
}
,
userStorageArmId:
{
Description: The arm Id key of the workspace storage ,
Required: False ,
}
string ,
userStorageKey:
{
Description: The access key of the workspace storage ,
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 ,
}
,
]
,
}
,
}
Workspaces_ListNotebookAccessToken (new)
Description :  Get Azure Machine Learning Workspace notebook access token
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
accessToken:
{
Required: False ,
}
string ,
expiresIn:
{
Format: int32 ,
Required: False ,
}
integer ,
hostName:
{
Required: False ,
}
string ,
notebookResourceId:
{
Required: False ,
}
string ,
publicDns:
{
Required: False ,
}
string ,
refreshToken:
{
Required: False ,
}
string ,
scope:
{
Required: False ,
}
string ,
tokenType:
{
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 ,
}
,
]
,
}
,
}
Workspaces_ListNotebookKeys (new)
Description :  Lists keys of Azure Machine Learning Workspaces notebook.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
primaryAccessKey:
{
Description: The primary access key of the Notebook ,
Required: False ,
}
string ,
secondaryAccessKey:
{
Description: The secondary access key of the Notebook ,
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 ,
}
,
]
,
}
,
}
Workspaces_ListStorageAccountKeys (new)
Description :  Lists keys of Azure Machine Learning Workspace's storage account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
userStorageKey:
{
Description: The access key of the storage ,
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 ,
}
,
]
,
}
,
}
Workspaces_ListOutboundNetworkDependenciesEndpoints (new)
Description :  Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
category:
{
Required: False ,
}
string ,
endpoints:
{
Required: False ,
}
[
{
domainName:
{
Required: False ,
}
string ,
endpointDetails:
{
Required: False ,
}
[
{
port:
{
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 ,
}
,
]
,
}
,
}
ManagedNetworkSettingsRule_List (new)
Description :  Lists the managed network outbound rules for a machine learning workspace.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page constructed using the continuationToken. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces. ,
Required: False ,
}
[
{
properties:
{
Description: Outbound Rule for the managed network of a machine learning workspace. ,
Required: True ,
}
{
category:
{
Description: Category of a managed network Outbound Rule of a machine learning workspace. ,
Enum:
{
Required: No description available. ,
Recommended: No description available. ,
UserDefined: No description available. ,
Dependency: No description available. ,
}
,
Required: False ,
}
enum ,
parentRuleNames:
{
Required: False ,
}
[
string ,
]
,
status:
{
Description: Type of a managed network Outbound Rule of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of a managed network Outbound Rule of a machine learning workspace. ,
Enum:
{
FQDN: No description available. ,
PrivateEndpoint: No description available. ,
ServiceTag: 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 ,
}
,
]
,
}
,
}
ManagedNetworkSettingsRule_Delete (new)
Description :  Deletes an outbound rule from the managed network of a machine learning workspace.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
ruleName:
{
Description: Name of the workspace managed network outbound rule ,
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 (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 ,
}
,
]
,
}
,
}
ManagedNetworkSettingsRule_Get (new)
Description :  Gets an outbound rule from the managed network of a machine learning workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
ruleName:
{
Description: Name of the workspace managed network outbound rule ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Outbound Rule for the managed network of a machine learning workspace. ,
Required: True ,
}
{
category:
{
Description: Category of a managed network Outbound Rule of a machine learning workspace. ,
Enum:
{
Required: No description available. ,
Recommended: No description available. ,
UserDefined: No description available. ,
Dependency: No description available. ,
}
,
Required: False ,
}
enum ,
parentRuleNames:
{
Required: False ,
}
[
string ,
]
,
status:
{
Description: Type of a managed network Outbound Rule of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of a managed network Outbound Rule of a machine learning workspace. ,
Enum:
{
FQDN: No description available. ,
PrivateEndpoint: No description available. ,
ServiceTag: 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 ,
}
,
]
,
}
,
}
ManagedNetworkSettingsRule_CreateOrUpdate (new)
Description :  Creates or updates an outbound rule in the managed network of a machine learning workspace.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundRules/{ruleName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
ruleName:
{
Description: Name of the workspace managed network outbound rule ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Outbound Rule to be created or updated in the managed network of a machine learning workspace. ,
Required: True ,
}
{
properties:
{
Description: Outbound Rule for the managed network of a machine learning workspace. ,
Required: True ,
}
{
category:
{
Description: Category of a managed network Outbound Rule of a machine learning workspace. ,
Enum:
{
Required: No description available. ,
Recommended: No description available. ,
UserDefined: No description available. ,
Dependency: No description available. ,
}
,
Required: False ,
}
enum ,
parentRuleNames:
{
Required: False ,
}
[
string ,
]
,
status:
{
Description: Type of a managed network Outbound Rule of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of a managed network Outbound Rule of a machine learning workspace. ,
Enum:
{
FQDN: No description available. ,
PrivateEndpoint: No description available. ,
ServiceTag: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Outbound Rule for the managed network of a machine learning workspace. ,
Required: True ,
}
{
category:
{
Description: Category of a managed network Outbound Rule of a machine learning workspace. ,
Enum:
{
Required: No description available. ,
Recommended: No description available. ,
UserDefined: No description available. ,
Dependency: No description available. ,
}
,
Required: False ,
}
enum ,
parentRuleNames:
{
Required: False ,
}
[
string ,
]
,
status:
{
Description: Type of a managed network Outbound Rule of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of a managed network Outbound Rule of a machine learning workspace. ,
Enum:
{
FQDN: No description available. ,
PrivateEndpoint: No description available. ,
ServiceTag: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Workspaces_PrepareNotebook (new)
Description :  Prepare Azure Machine Learning Workspace's notebook resource
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
fqdn:
{
Required: False ,
}
string ,
isPrivateLinkEnabled:
{
Required: False ,
}
boolean ,
notebookPreparationError:
{
Description: The error that occurs when preparing notebook. ,
Required: False ,
}
{
errorMessage:
{
Required: False ,
}
string ,
statusCode:
{
Format: int32 ,
Required: False ,
}
integer ,
}
,
resourceId:
{
Description: the data plane resourceId that used to initialize notebook component ,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (new)
Description :  Called by end-users to get all PE connections.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
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 ,
}
,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource. ,
Required: False ,
}
{
id:
{
Description: e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} ,
Required: False ,
}
string ,
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Called by end-users to delete a PE connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: NRP Private Endpoint Connection 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Called by end-users to get a PE connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: NRP Private Endpoint Connection 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 ,
}
,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource. ,
Required: False ,
}
{
id:
{
Description: e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} ,
Required: False ,
}
string ,
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Called by end-users to approve or reject a PE connection. This method must validate and forward the call to NRP.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: NRP Private Endpoint Connection Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: PrivateEndpointConnection 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 ,
}
,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource. ,
Required: False ,
}
{
id:
{
Description: e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} ,
Required: False ,
}
string ,
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
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 ,
}
,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Private endpoint connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The Private Endpoint resource. ,
Required: False ,
}
{
id:
{
Description: e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} ,
Required: False ,
}
string ,
subnetArmId:
{
Description: The subnetId that the private endpoint is connected to. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: The connection state. ,
Required: False ,
}
{
actionsRequired:
{
Description: Some RP chose "None". Other RPs use this for region expansion. ,
Required: False ,
}
string ,
description:
{
Description: User-defined message that, per NRP doc, may be used for approval-related message. ,
Required: False ,
}
string ,
status:
{
Description: Connection status of the service consumer with the service provider Possible state transitions Pending -> Approved (Service provider approves the connection request) Pending -> Rejected (Service provider rejects the connection request) Pending -> Disconnected (Service provider deletes the connection) Approved -> Rejected (Service provider rejects the approved connection) Approved -> Disconnected (Service provider deletes the connection) Rejected -> Pending (Service consumer re-initiates the connection request that was rejected) Rejected -> Disconnected (Service provider deletes the connection) ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The current provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateLinkResources_List (new)
Description :  Called by Client (Portal, CLI, etc) to get available "private link resources" for the workspace. Each "private link resource" is a connection endpoint (IP address) to the resource. Pre single connection endpoint per workspace: the Data Plane IP address, returned by DNS resolution. Other RPs, such as Azure Storage, have multiple - one for Blobs, other for Queues, etc. Defined in the "[NRP] Private Endpoint Design" doc, topic "GET API for GroupIds".
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
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 ,
}
,
location:
{
Description: Same as workspace location. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of a private link resource. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
sku:
{
Description: Optional. This field is required to be implemented by the RP because AML is supporting more than one tier ,
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 ,
}
,
tags:
{
Required: False ,
}
object ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
ManagedNetworkProvisions_ProvisionManagedNetwork (new)
Description :  Provisions the managed network of a machine learning workspace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/provisionManagedNetwork
{
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: Azure Machine Learning Workspace Name ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Managed Network Provisioning Options for a machine learning workspace. ,
Required: False ,
}
{
includeSpark:
{
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
sparkReady:
{
Required: False ,
}
boolean ,
status:
{
Description: Status for the managed network of a machine learning workspace. ,
Enum:
{
Inactive: No description available. ,
Active: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Workspaces_ResyncKeys (new)
Description :  Resync all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container registry
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys
{
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: Azure Machine Learning Workspace Name ,
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 ,
}
,
]
,
}
,
}