Batch Endpoints - List Keys

Service:

Machine Learning

API Version:

2023-10-01

Lists batch Inference Endpoint keys.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/batchEndpoints/{endpointName}/listkeys?api-version=2023-10-01

URI Parameters

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

Responses

Name	Type	Description
200 OK	EndpointAuthKeys	Success
Other Status Codes	ErrorResponse	Error

Examples

ListKeys Workspace Batch Endpoint.

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/batchEndpoints/testEndpointName/listkeys?api-version=2023-10-01

Sample Response

Status code:

200

{
  "primaryKey": "string",
  "secondaryKey": "string"
}

Definitions

Name	Description
EndpointAuthKeys	Keys for endpoint authentication.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

EndpointAuthKeys

Keys for endpoint authentication.

Name	Type	Description
primaryKey	string	The primary key.
secondaryKey	string	The secondary key.

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorDetail

The error detail.

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

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.