OnlineEndpoints interface

Package:

@azure/arm-machinelearning

Interface representing a OnlineEndpoints.

Methods

beginCreateOrUpdate(string, string, string, OnlineEndpoint, OnlineEndpointsCreateOrUpdateOptionalParams)	Create or update Online Endpoint (asynchronous).
beginCreateOrUpdateAndWait(string, string, string, OnlineEndpoint, OnlineEndpointsCreateOrUpdateOptionalParams)	Create or update Online Endpoint (asynchronous).
beginDelete(string, string, string, OnlineEndpointsDeleteOptionalParams)	Delete Online Endpoint (asynchronous).
beginDeleteAndWait(string, string, string, OnlineEndpointsDeleteOptionalParams)	Delete Online Endpoint (asynchronous).
beginRegenerateKeys(string, string, string, RegenerateEndpointKeysRequest, OnlineEndpointsRegenerateKeysOptionalParams)	Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).
beginRegenerateKeysAndWait(string, string, string, RegenerateEndpointKeysRequest, OnlineEndpointsRegenerateKeysOptionalParams)	Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).
beginUpdate(string, string, string, PartialMinimalTrackedResourceWithIdentity, OnlineEndpointsUpdateOptionalParams)	Update Online Endpoint (asynchronous).
beginUpdateAndWait(string, string, string, PartialMinimalTrackedResourceWithIdentity, OnlineEndpointsUpdateOptionalParams)	Update Online Endpoint (asynchronous).
get(string, string, string, OnlineEndpointsGetOptionalParams)	Get Online Endpoint.
getToken(string, string, string, OnlineEndpointsGetTokenOptionalParams)	Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.
list(string, string, OnlineEndpointsListOptionalParams)	List Online Endpoints.
listKeys(string, string, string, OnlineEndpointsListKeysOptionalParams)	List EndpointAuthKeys for an Endpoint using Key-based authentication.

Method Details

beginCreateOrUpdate(string, string, string, OnlineEndpoint, OnlineEndpointsCreateOrUpdateOptionalParams)

Create or update Online Endpoint (asynchronous).

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, endpointName: string, body: OnlineEndpoint, options?: OnlineEndpointsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<OnlineEndpoint>, OnlineEndpoint>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Online Endpoint name.

body

OnlineEndpoint

Online Endpoint entity to apply during operation.

options

OnlineEndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OnlineEndpoint>, OnlineEndpoint>>

beginCreateOrUpdateAndWait(string, string, string, OnlineEndpoint, OnlineEndpointsCreateOrUpdateOptionalParams)

Create or update Online Endpoint (asynchronous).

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, body: OnlineEndpoint, options?: OnlineEndpointsCreateOrUpdateOptionalParams): Promise<OnlineEndpoint>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Online Endpoint name.

body

OnlineEndpoint

Online Endpoint entity to apply during operation.

options

OnlineEndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<OnlineEndpoint>

beginDelete(string, string, string, OnlineEndpointsDeleteOptionalParams)

Delete Online Endpoint (asynchronous).

function beginDelete(resourceGroupName: string, workspaceName: string, endpointName: string, options?: OnlineEndpointsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Online Endpoint name.

options

OnlineEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, OnlineEndpointsDeleteOptionalParams)

Delete Online Endpoint (asynchronous).

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, options?: OnlineEndpointsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Online Endpoint name.

options

OnlineEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRegenerateKeys(string, string, string, RegenerateEndpointKeysRequest, OnlineEndpointsRegenerateKeysOptionalParams)

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

function beginRegenerateKeys(resourceGroupName: string, workspaceName: string, endpointName: string, body: RegenerateEndpointKeysRequest, options?: OnlineEndpointsRegenerateKeysOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Online Endpoint name.

body

RegenerateEndpointKeysRequest

RegenerateKeys request .

options

OnlineEndpointsRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRegenerateKeysAndWait(string, string, string, RegenerateEndpointKeysRequest, OnlineEndpointsRegenerateKeysOptionalParams)

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

function beginRegenerateKeysAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, body: RegenerateEndpointKeysRequest, options?: OnlineEndpointsRegenerateKeysOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Online Endpoint name.

body

RegenerateEndpointKeysRequest

RegenerateKeys request .

options

OnlineEndpointsRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, PartialMinimalTrackedResourceWithIdentity, OnlineEndpointsUpdateOptionalParams)

Update Online Endpoint (asynchronous).

function beginUpdate(resourceGroupName: string, workspaceName: string, endpointName: string, body: PartialMinimalTrackedResourceWithIdentity, options?: OnlineEndpointsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<OnlineEndpoint>, OnlineEndpoint>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Online Endpoint name.

body

PartialMinimalTrackedResourceWithIdentity

Online Endpoint entity to apply during operation.

options

OnlineEndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OnlineEndpoint>, OnlineEndpoint>>

beginUpdateAndWait(string, string, string, PartialMinimalTrackedResourceWithIdentity, OnlineEndpointsUpdateOptionalParams)

Update Online Endpoint (asynchronous).

function beginUpdateAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, body: PartialMinimalTrackedResourceWithIdentity, options?: OnlineEndpointsUpdateOptionalParams): Promise<OnlineEndpoint>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Online Endpoint name.

body

PartialMinimalTrackedResourceWithIdentity

Online Endpoint entity to apply during operation.

options

OnlineEndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<OnlineEndpoint>

get(string, string, string, OnlineEndpointsGetOptionalParams)

Get Online Endpoint.

function get(resourceGroupName: string, workspaceName: string, endpointName: string, options?: OnlineEndpointsGetOptionalParams): Promise<OnlineEndpoint>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Online Endpoint name.

options

OnlineEndpointsGetOptionalParams

The options parameters.

Returns

Promise<OnlineEndpoint>

getToken(string, string, string, OnlineEndpointsGetTokenOptionalParams)

Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.

function getToken(resourceGroupName: string, workspaceName: string, endpointName: string, options?: OnlineEndpointsGetTokenOptionalParams): Promise<EndpointAuthToken>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Online Endpoint name.

options

OnlineEndpointsGetTokenOptionalParams

The options parameters.

Returns

Promise<EndpointAuthToken>

list(string, string, OnlineEndpointsListOptionalParams)

List Online Endpoints.

function list(resourceGroupName: string, workspaceName: string, options?: OnlineEndpointsListOptionalParams): PagedAsyncIterableIterator<OnlineEndpoint, OnlineEndpoint[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

options

OnlineEndpointsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<OnlineEndpoint, OnlineEndpoint[], PageSettings>

listKeys(string, string, string, OnlineEndpointsListKeysOptionalParams)

List EndpointAuthKeys for an Endpoint using Key-based authentication.

function listKeys(resourceGroupName: string, workspaceName: string, endpointName: string, options?: OnlineEndpointsListKeysOptionalParams): Promise<EndpointAuthKeys>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Online Endpoint name.

options

OnlineEndpointsListKeysOptionalParams

The options parameters.

Returns

Promise<EndpointAuthKeys>