Package com.azure.resourcemanager.machinelearning.models

Interface ComputeResource

public interface ComputeResource
An immutable client-side representation of ComputeResource.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    ComputeResource.Definition
    The entirety of the ComputeResource definition.
    static interface 
    ComputeResource.DefinitionStages
    The ComputeResource definition stages.
    static interface 
    ComputeResource.Update
    The template for ComputeResource update.
    static interface 
    ComputeResource.UpdateStages
    The ComputeResource update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    ManagedServiceIdentity
    identity()
    Gets the identity property: The identity of the resource.
    ComputeResourceInner
    innerModel()
    Gets the inner com.azure.resourcemanager.machinelearning.fluent.models.ComputeResourceInner object.
    ComputeSecrets
    listKeys()
    Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
    com.azure.core.http.rest.Response<ComputeSecrets>
    listKeysWithResponse(com.azure.core.util.Context context)
    Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
    com.azure.core.http.rest.PagedIterable<AmlComputeNodeInformation>
    listNodes()
    Get the details (e.g IP address, port etc) of all the compute nodes in the compute.
    com.azure.core.http.rest.PagedIterable<AmlComputeNodeInformation>
    listNodes(com.azure.core.util.Context context)
    Get the details (e.g IP address, port etc) of all the compute nodes in the compute.
    String
    location()
    Gets the location property: Specifies the location of the resource.
    String
    name()
    Gets the name property: The name of the resource.
    Compute
    properties()
    Gets the properties property: Compute properties.
    ComputeResource
    refresh()
    Refreshes the resource to sync with Azure.
    ComputeResource
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    com.azure.core.management.Region
    region()
    Gets the region of the resource.
    String
    regionName()
    Gets the name of the resource region.
    String
    resourceGroupName()
    Gets the name of the resource group.
    void
    restart()
    Posts a restart action to a compute instance.
    void
    restart(com.azure.core.util.Context context)
    Posts a restart action to a compute instance.
    Sku
    sku()
    Gets the sku property: The sku of the workspace.
    void
    start()
    Posts a start action to a compute instance.
    void
    start(com.azure.core.util.Context context)
    Posts a start action to a compute instance.
    void
    stop()
    Posts a stop action to a compute instance.
    void
    stop(com.azure.core.util.Context context)
    Posts a stop action to a compute instance.
    com.azure.core.management.SystemData
    systemData()
    Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Map<String,String>
    tags()
    Gets the tags property: Contains resource tags defined as key/value pairs.
    String
    type()
    Gets the type property: The type of the resource.
    ComputeResource.Update
    update()
    Begins update for the ComputeResource 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.

    • identity

      ManagedServiceIdentity identity()
      Gets the identity property: The identity of the resource.
      Returns:
      the identity value.

    • location

      String location()
      Gets the location property: Specifies the location of the resource.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Contains resource tags defined as key/value pairs.
      Returns:
      the tags value.

    • sku

      Sku sku()
      Gets the sku property: The sku of the workspace.
      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.

    • properties

      Compute properties()
      Gets the properties property: Compute properties.
      Returns:
      the properties 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

      ComputeResourceInner innerModel()
      Gets the inner com.azure.resourcemanager.machinelearning.fluent.models.ComputeResourceInner object.
      Returns:
      the inner object.

    • update

      ComputeResource.Update update()
      Begins update for the ComputeResource resource.
      Returns:
      the stage of resource update.

    • refresh

      ComputeResource refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      ComputeResource refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • listNodes

      com.azure.core.http.rest.PagedIterable<AmlComputeNodeInformation> listNodes()
      Get the details (e.g IP address, port etc) of all the compute nodes in the compute.
      Returns:
      the details (e.g IP address, port etc) of all the compute nodes in the compute as paginated response with PagedIterable.
      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.

    • listNodes

      com.azure.core.http.rest.PagedIterable<AmlComputeNodeInformation> listNodes(com.azure.core.util.Context context)
      Get the details (e.g IP address, port etc) of all the compute nodes in the compute.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the details (e.g IP address, port etc) of all the compute nodes in the compute as paginated response with PagedIterable.
      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.

    • listKeysWithResponse

      com.azure.core.http.rest.Response<ComputeSecrets> listKeysWithResponse(com.azure.core.util.Context context)
      Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
      Parameters:
      context - The context to associate with this operation.
      Returns:
      secrets related to Machine Learning compute (storage keys, service credentials, etc) 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

      ComputeSecrets listKeys()
      Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
      Returns:
      secrets related to Machine Learning compute (storage keys, service credentials, etc).
      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.

    • start

      void start()
      Posts a start action to a compute instance.
      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.

    • start

      void start(com.azure.core.util.Context context)
      Posts a start action to a compute instance.
      Parameters:
      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.

    • stop

      void stop()
      Posts a stop action to a compute instance.
      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.

    • stop

      void stop(com.azure.core.util.Context context)
      Posts a stop action to a compute instance.
      Parameters:
      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.

    • restart

      void restart()
      Posts a restart action to a compute instance.
      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.

    • restart

      void restart(com.azure.core.util.Context context)
      Posts a restart action to a compute instance.
      Parameters:
      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.