Online Endpoints - Regenerate Keys

Service:

Machine Learning

API Version:

2024-04-01

Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/regenerateKeys?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
endpointName	path	True	string	Online 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.

Request Body

Name	Required	Type	Description
keyType	True	KeyType	[Required] Specification for which type of key to generate. Primary or Secondary.
keyValue		string	The value the key is set to.

Responses

Name	Type	Description
200 OK		Success
202 Accepted		Accepted Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Error

Examples

RegenerateKeys Workspace Online 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/onlineEndpoints/testEndpointName/regenerateKeys?api-version=2024-04-01

{
  "keyType": "Primary",
  "keyValue": "string"
}

Sample Response

Status code:

200

Status code:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/...pathToOperationStatus...
Location: https://management.azure.com/subscriptions/...pathToOperationResult...

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
KeyType
RegenerateEndpointKeysRequest

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.

KeyType

Name	Type	Description
Primary	string
Secondary	string

RegenerateEndpointKeysRequest

Name	Type	Description
keyType	KeyType	[Required] Specification for which type of key to generate. Primary or Secondary.
keyValue	string	The value the key is set to.