Interface OnlineEndpoint
public interface OnlineEndpoint
An immutable client-side representation of OnlineEndpoint.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceThe entirety of the OnlineEndpoint definition.static interfaceThe OnlineEndpoint definition stages.static interfaceThe template for OnlineEndpoint update.static interfaceThe OnlineEndpoint update stages. -
Method Summary
Modifier and TypeMethodDescriptiongetToken()Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.com.azure.core.http.rest.Response<EndpointAuthToken>getTokenWithResponse(com.azure.core.util.Context context) Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.id()Gets the id property: Fully qualified resource Id for the resource.identity()Gets the identity property: Managed service identity (system assigned and/or user assigned identities).Gets the inner com.azure.resourcemanager.machinelearning.fluent.models.OnlineEndpointInner object.kind()Gets the kind property: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.listKeys()List EndpointAuthKeys for an Endpoint using Key-based authentication.com.azure.core.http.rest.Response<EndpointAuthKeys>listKeysWithResponse(com.azure.core.util.Context context) List EndpointAuthKeys for an Endpoint using Key-based authentication.location()Gets the location property: The geo-location where the resource lives.name()Gets the name property: The name of the resource.Gets the properties property: [Required] Additional attributes of the entity.refresh()Refreshes the resource to sync with Azure.refresh(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.voidRegenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).voidregenerateKeys(RegenerateEndpointKeysRequest body, com.azure.core.util.Context context) Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).com.azure.core.management.Regionregion()Gets the region of the resource.Gets the name of the resource region.Gets the name of the resource group.sku()Gets the sku property: Sku details required for ARM contract for Autoscaling.com.azure.core.management.SystemDataGets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.tags()Gets the tags property: Resource tags.type()Gets the type property: The type of the resource.update()Begins update for the OnlineEndpoint resource.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()Gets the type property: The type of the resource.- Returns:
- the type value.
-
location
String location()Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
tags
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
properties
OnlineEndpointProperties properties()Gets the properties property: [Required] Additional attributes of the entity.- Returns:
- the properties value.
-
kind
String kind()Gets the kind property: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.- Returns:
- the kind value.
-
identity
ManagedServiceIdentity identity()Gets the identity property: Managed service identity (system assigned and/or user assigned identities).- Returns:
- the identity value.
-
sku
Sku sku()Gets the sku property: Sku details required for ARM contract for Autoscaling.- Returns:
- the sku value.
-
systemData
com.azure.core.management.SystemData systemData()Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.- Returns:
- the systemData value.
-
region
com.azure.core.management.Region region()Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
String regionName()Gets the name of the resource region.- Returns:
- the name of the resource region.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
OnlineEndpointInner innerModel()Gets the inner com.azure.resourcemanager.machinelearning.fluent.models.OnlineEndpointInner object.- Returns:
- the inner object.
-
update
OnlineEndpoint.Update update()Begins update for the OnlineEndpoint resource.- Returns:
- the stage of resource update.
-
refresh
OnlineEndpoint refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context- The context to associate with this operation.- Returns:
- the refreshed resource.
-
listKeysWithResponse
com.azure.core.http.rest.Response<EndpointAuthKeys> listKeysWithResponse(com.azure.core.util.Context context) List EndpointAuthKeys for an Endpoint using Key-based authentication.- Parameters:
context- The context to associate with this operation.- Returns:
- keys for endpoint authentication along with
Response. - Throws:
IllegalArgumentException- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-
listKeys
EndpointAuthKeys listKeys()List EndpointAuthKeys for an Endpoint using Key-based authentication.- Returns:
- keys for endpoint authentication.
- Throws:
com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-
regenerateKeys
Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).- Parameters:
body- RegenerateKeys request .- Throws:
IllegalArgumentException- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-
regenerateKeys
Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).- Parameters:
body- RegenerateKeys request .context- The context to associate with this operation.- Throws:
IllegalArgumentException- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-
getTokenWithResponse
com.azure.core.http.rest.Response<EndpointAuthToken> getTokenWithResponse(com.azure.core.util.Context context) Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.- Parameters:
context- The context to associate with this operation.- Returns:
- service Token along with
Response. - Throws:
IllegalArgumentException- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-
getToken
EndpointAuthToken getToken()Retrieve a valid AML token for an Endpoint using AMLToken-based authentication.- Returns:
- service Token.
- Throws:
com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-