ServerlessEndpointOperations Class

  • Reference

ServerlessEndpointOperations.

You should not instantiate this class directly. Instead, you should create an MLClient instance that instantiates it for you and attaches it as an attribute.

Inheritance
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
ServerlessEndpointOperations

Constructor

ServerlessEndpointOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client: AzureMachineLearningWorkspaces, all_operations: OperationsContainer)

Parameters

Name Description
operation_scope
Required
operation_config
Required
service_client
Required
all_operations
Required

Methods

begin_create_or_update

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Create or update a serverless endpoint.
begin_delete

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Delete a Serverless Endpoint.
begin_regenerate_keys

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Regenerate keys for a serverless endpoint.
get

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Get a Serverless Endpoint resource.
get_keys

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Get serveless endpoint auth keys.
list

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

List serverless endpoints of the workspace.

begin_create_or_update

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Create or update a serverless endpoint.

begin_create_or_update(endpoint: ServerlessEndpoint, **kwargs) -> LROPoller[ServerlessEndpoint]

Parameters

Name Description
endpoint
Required
ServerlessEndpoint

The serverless endpoint entity.

Returns

Type Description
LROPoller[ServerlessEndpoint]

A poller to track the operation status

Exceptions

Type Description
ValidationException

Raised if ServerlessEndpoint cannot be successfully validated. Details will be provided in the error message.

begin_delete

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Delete a Serverless Endpoint.

begin_delete(name: str, **kwargs) -> LROPoller[None]

Parameters

Name Description
name
Required
str

Name of the serverless endpoint.

Returns

Type Description
LROPoller[None]

A poller to track the operation status.

Exceptions

Type Description
ValidationException

Raised if ServerlessEndpoint cannot be successfully validated. Details will be provided in the error message.

begin_regenerate_keys

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Regenerate keys for a serverless endpoint.

begin_regenerate_keys(name: str, *, key_type: str = 'primary', **kwargs) -> LROPoller[EndpointAuthKeys]

Parameters

Name Description
name
Required
str

The endpoint name.

Keyword-Only Parameters

Name Description
key_type
str

One of "primary", "secondary". Defaults to "primary".

Returns

Type Description
LROPoller[EndpointAuthKeys]

A poller to track the operation status.

Exceptions

Type Description
ValidationException

Raised if key_type is not "primary" or "secondary"

get

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Get a Serverless Endpoint resource.

get(name: str, **kwargs) -> ServerlessEndpoint

Parameters

Name Description
name
Required
str

Name of the serverless endpoint.

Returns

Type Description
ServerlessEndpoint

Serverless endpoint object retrieved from the service.

Exceptions

Type Description
ValidationException

Raised if ServerlessEndpoint cannot be successfully validated. Details will be provided in the error message.

get_keys

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Get serveless endpoint auth keys.

get_keys(name: str, **kwargs) -> EndpointAuthKeys

Parameters

Name Description
name
Required
str

The serverless endpoint name

Returns

Type Description
EndpointAuthKeys

Returns the keys of the serverless endpoint

Exceptions

Type Description
ValidationException

Raised if ServerlessEndpoint cannot be successfully validated. Details will be provided in the error message.

list

Note

This is an experimental method, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

List serverless endpoints of the workspace.

list(**kwargs) -> Iterable[ServerlessEndpoint]

Returns

Type Description
Iterable[ServerlessEndpoint]

A list of serverless endpoints

Exceptions

Type Description
ValidationException

Raised if ServerlessEndpoint cannot be successfully validated. Details will be provided in the error message.