Batch Endpoints - Get
Gets a batch inference endpoint by name.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}?api-version=2024-04-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Name for the Batch Endpoint. |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
workspace
|
path | True |
string |
Name of Azure Machine Learning workspace. Regex pattern: |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
Error |
Examples
Get Workspace Batch Endpoint.
Sample request
GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName?api-version=2024-04-01
Sample response
{
"id": "string",
"name": "string",
"type": "string",
"properties": {
"description": "string",
"properties": {
"string": "string"
},
"scoringUri": "https://www.contoso.com/example",
"swaggerUri": "https://www.contoso.com/example",
"authMode": "AMLToken",
"defaults": {
"deploymentName": "string"
}
},
"systemData": {
"createdAt": "2020-01-01T12:34:56.999Z",
"createdBy": "string",
"createdByType": "User",
"lastModifiedAt": "2020-01-01T12:34:56.999Z",
"lastModifiedBy": "string",
"lastModifiedByType": "User"
},
"tags": {},
"location": "string",
"kind": "string",
"identity": {
"type": "SystemAssigned",
"principalId": "00000000-1111-2222-3333-444444444444",
"tenantId": "00000000-1111-2222-3333-444444444444",
"userAssignedIdentities": {
"string": {
"principalId": "00000000-1111-2222-3333-444444444444",
"clientId": "00000000-1111-2222-3333-444444444444"
}
}
},
"sku": {
"name": "string",
"tier": "Free",
"size": "string",
"family": "string",
"capacity": 1
}
}
Definitions
Name | Description |
---|---|
Batch |
Batch endpoint configuration. |
Batch |
Batch endpoint default values |
Batch |
|
created |
The type of identity that created the resource. |
Endpoint |
Keys for endpoint authentication. |
Endpoint |
Enum to determine endpoint authentication mode. |
Endpoint |
State of endpoint provisioning. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Managed |
Managed service identity (system assigned and/or user assigned identities) |
Managed |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
Sku |
The resource model definition representing SKU |
Sku |
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. |
system |
Metadata pertaining to creation and last modification of the resource. |
User |
User assigned identity properties |
BatchEndpoint
Batch endpoint configuration.
Name | Type | Description |
---|---|---|
authMode |
[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does. |
|
defaults |
Default values for Batch Endpoint |
|
description |
string |
Description of the inference endpoint. |
keys |
EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API. |
|
properties |
object |
Property dictionary. Properties can be added, but not removed or altered. |
provisioningState |
Provisioning state for the endpoint. |
|
scoringUri |
string |
Endpoint URI. |
swaggerUri |
string |
Endpoint Swagger URI. |
BatchEndpointDefaults
Batch endpoint default values
Name | Type | Description |
---|---|---|
deploymentName |
string |
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. |
BatchEndpointTrackedResource
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
Managed service identity (system assigned and/or user assigned identities) |
|
kind |
string |
Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. |
location |
string |
The geo-location where the resource lives |
name |
string |
The name of the resource |
properties |
[Required] Additional attributes of the entity. |
|
sku |
Sku details required for ARM contract for Autoscaling. |
|
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
tags |
object |
Resource tags. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
EndpointAuthKeys
Keys for endpoint authentication.
Name | Type | Description |
---|---|---|
primaryKey |
string |
The primary key. |
secondaryKey |
string |
The secondary key. |
EndpointAuthMode
Enum to determine endpoint authentication mode.
Name | Type | Description |
---|---|---|
AADToken |
string |
|
AMLToken |
string |
|
Key |
string |
EndpointProvisioningState
State of endpoint provisioning.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Name | Type | Description |
---|---|---|
principalId |
string |
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId |
string |
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
type |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
|
userAssignedIdentities |
<string,
User |
User-Assigned Identities |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned,UserAssigned |
string |
|
UserAssigned |
string |
Sku
The resource model definition representing SKU
Name | Type | Description |
---|---|---|
capacity |
integer |
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. |
family |
string |
If the service has different generations of hardware, for the same SKU, then that can be captured here. |
name |
string |
The name of the SKU. Ex - P3. It is typically a letter+number code |
size |
string |
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. |
tier |
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. |
SkuTier
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.
Name | Type | Description |
---|---|---|
Basic |
string |
|
Free |
string |
|
Premium |
string |
|
Standard |
string |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
UserAssignedIdentity
User assigned identity properties
Name | Type | Description |
---|---|---|
clientId |
string |
The client ID of the assigned identity. |
principalId |
string |
The principal ID of the assigned identity. |