OnlineEndpoints | @azure/arm-machinelearning

Interface representing a OnlineEndpoints.

Hierarchy

OnlineEndpoints

Implemented by

OnlineEndpointsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, endpointName: string, body: OnlineEndpointData, options?: OnlineEndpointsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<OnlineEndpointsCreateOrUpdateResponse>, OnlineEndpointsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/onlineEndpoints.ts:126
Create or update Online Endpoint (asynchronous).

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: OnlineEndpointData
  
  Online Endpoint entity to apply during operation.
- Optional options: OnlineEndpointsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<OnlineEndpointsCreateOrUpdateResponse>, OnlineEndpointsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/onlineEndpoints.ts:146
Create or update Online Endpoint (asynchronous).

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: OnlineEndpointData
  
  Online Endpoint entity to apply during operation.
- Optional options: OnlineEndpointsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<OnlineEndpointsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, workspaceName: string, endpointName: string, options?: OnlineEndpointsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/onlineEndpoints.ts:51
Delete Online Endpoint (asynchronous).

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.
- Optional options: OnlineEndpointsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/onlineEndpoints.ts:64
Delete Online Endpoint (asynchronous).

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.
- Optional options: OnlineEndpointsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRegenerateKeys

beginRegenerateKeys(resourceGroupName: string, workspaceName: string, endpointName: string, body: RegenerateEndpointKeysRequest, options?: OnlineEndpointsRegenerateKeysOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/onlineEndpoints.ts:174
Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).

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 .
- Optional options: OnlineEndpointsRegenerateKeysOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRegenerateKeysAndWait

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

- Defined in operationsInterfaces/onlineEndpoints.ts:189
Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).

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 .
- Optional options: OnlineEndpointsRegenerateKeysOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, workspaceName: string, endpointName: string, body: PartialOnlineEndpointPartialTrackedResource, options?: OnlineEndpointsUpdateOptionalParams): Promise<PollerLike<PollOperationState<OnlineEndpointsUpdateResponse>, OnlineEndpointsUpdateResponse>>

- Defined in operationsInterfaces/onlineEndpoints.ts:91
Update Online Endpoint (asynchronous).

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: PartialOnlineEndpointPartialTrackedResource
  
  Online Endpoint entity to apply during operation.
- Optional options: OnlineEndpointsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<OnlineEndpointsUpdateResponse>, OnlineEndpointsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, body: PartialOnlineEndpointPartialTrackedResource, options?: OnlineEndpointsUpdateOptionalParams): Promise<OnlineEndpointsUpdateResponse>

- Defined in operationsInterfaces/onlineEndpoints.ts:111
Update Online Endpoint (asynchronous).

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: PartialOnlineEndpointPartialTrackedResource
  
  Online Endpoint entity to apply during operation.
- Optional options: OnlineEndpointsUpdateOptionalParams
  
  The options parameters.
Returns Promise<OnlineEndpointsUpdateResponse>

get

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

- Defined in operationsInterfaces/onlineEndpoints.ts:77
Get Online Endpoint.

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.
- Optional options: OnlineEndpointsGetOptionalParams
  
  The options parameters.
Returns Promise<OnlineEndpointsGetResponse>

getToken

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

- Defined in operationsInterfaces/onlineEndpoints.ts:203
Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.

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.
- Optional options: OnlineEndpointsGetTokenOptionalParams
  
  The options parameters.
Returns Promise<OnlineEndpointsGetTokenResponse>

list

list(resourceGroupName: string, workspaceName: string, options?: OnlineEndpointsListOptionalParams): PagedAsyncIterableIterator<OnlineEndpointData>

- Defined in operationsInterfaces/onlineEndpoints.ts:39
List Online Endpoints.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: OnlineEndpointsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<OnlineEndpointData>

listKeys

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

- Defined in operationsInterfaces/onlineEndpoints.ts:160
List EndpointAuthKeys for an Endpoint using Key-based authentication.

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.
- Optional options: OnlineEndpointsListKeysOptionalParams
  
  The options parameters.
Returns Promise<OnlineEndpointsListKeysResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

body: OnlineEndpointData

Optional options: OnlineEndpointsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<OnlineEndpointsCreateOrUpdateResponse>, OnlineEndpointsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

body: OnlineEndpointData

Optional options: OnlineEndpointsCreateOrUpdateOptionalParams

Returns Promise<OnlineEndpointsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

Optional options: OnlineEndpointsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

Optional options: OnlineEndpointsDeleteOptionalParams

Returns Promise<void>

beginRegenerateKeys

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

body: RegenerateEndpointKeysRequest

Optional options: OnlineEndpointsRegenerateKeysOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRegenerateKeysAndWait

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

body: RegenerateEndpointKeysRequest

Optional options: OnlineEndpointsRegenerateKeysOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

body: PartialOnlineEndpointPartialTrackedResource

Optional options: OnlineEndpointsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<OnlineEndpointsUpdateResponse>, OnlineEndpointsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

body: PartialOnlineEndpointPartialTrackedResource

Optional options: OnlineEndpointsUpdateOptionalParams

Returns Promise<OnlineEndpointsUpdateResponse>

get

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

Optional options: OnlineEndpointsGetOptionalParams

Returns Promise<OnlineEndpointsGetResponse>

getToken

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

Optional options: OnlineEndpointsGetTokenOptionalParams