Interface InstancesClient


public interface InstancesClient
An instance of this class provides access to all the operations defined in InstancesClient.
  • Method Details

    • listByAccount

      com.azure.core.http.rest.PagedIterable<InstanceInner> listByAccount(String resourceGroupName, String accountName)
      Returns instances for the given account name.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      Returns:
      list of Instances 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.
    • listByAccount

      com.azure.core.http.rest.PagedIterable<InstanceInner> listByAccount(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      Returns instances for the given account name.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      context - The context to associate with this operation.
      Returns:
      list of Instances 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.
    • get

      InstanceInner get(String resourceGroupName, String accountName, String instanceName)
      Returns instance details for the given instance and account name.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      Returns:
      device Update instance details.
      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.
    • getWithResponse

      com.azure.core.http.rest.Response<InstanceInner> getWithResponse(String resourceGroupName, String accountName, String instanceName, com.azure.core.util.Context context)
      Returns instance details for the given instance and account name.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      context - The context to associate with this operation.
      Returns:
      device Update instance details 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.
    • head

      void head(String resourceGroupName, String accountName, String instanceName)
      Checks whether instance exists.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      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.
    • headWithResponse

      com.azure.core.http.rest.Response<Void> headWithResponse(String resourceGroupName, String accountName, String instanceName, com.azure.core.util.Context context)
      Checks whether instance exists.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      context - The context to associate with this operation.
      Returns:
      the 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.
    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<InstanceInner>,InstanceInner> beginCreate(String resourceGroupName, String accountName, String instanceName, InstanceInner instance)
      Creates or updates instance.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      instance - Instance details.
      Returns:
      the SyncPoller for polling of device Update instance details.
      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.
    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<InstanceInner>,InstanceInner> beginCreate(String resourceGroupName, String accountName, String instanceName, InstanceInner instance, com.azure.core.util.Context context)
      Creates or updates instance.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      instance - Instance details.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of device Update instance details.
      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.
    • create

      InstanceInner create(String resourceGroupName, String accountName, String instanceName, InstanceInner instance)
      Creates or updates instance.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      instance - Instance details.
      Returns:
      device Update instance details.
      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.
    • create

      InstanceInner create(String resourceGroupName, String accountName, String instanceName, InstanceInner instance, com.azure.core.util.Context context)
      Creates or updates instance.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      instance - Instance details.
      context - The context to associate with this operation.
      Returns:
      device Update instance details.
      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.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName, String instanceName)
      Deletes instance.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      Returns:
      the SyncPoller for polling of long-running 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.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName, String instanceName, com.azure.core.util.Context context)
      Deletes instance.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running 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.
    • delete

      void delete(String resourceGroupName, String accountName, String instanceName)
      Deletes instance.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      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.
    • delete

      void delete(String resourceGroupName, String accountName, String instanceName, com.azure.core.util.Context context)
      Deletes instance.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      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.
    • update

      InstanceInner update(String resourceGroupName, String accountName, String instanceName, TagUpdate tagUpdatePayload)
      Updates instance's tags.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      tagUpdatePayload - Updated tags.
      Returns:
      device Update instance details.
      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.
    • updateWithResponse

      com.azure.core.http.rest.Response<InstanceInner> updateWithResponse(String resourceGroupName, String accountName, String instanceName, TagUpdate tagUpdatePayload, com.azure.core.util.Context context)
      Updates instance's tags.
      Parameters:
      resourceGroupName - The resource group name.
      accountName - Account name.
      instanceName - Instance name.
      tagUpdatePayload - Updated tags.
      context - The context to associate with this operation.
      Returns:
      device Update instance details 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.