Interface Instances
public interface Instances
Resource collection API of Instances.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Instance resource.void
Deletes instance.void
delete
(String resourceGroupName, String accountName, String instanceName, com.azure.core.util.Context context) Deletes instance.void
deleteById
(String id) Deletes instance.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes instance.Returns instance details for the given instance and account name.Returns instance details for the given instance and account name.com.azure.core.http.rest.Response<Instance>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Returns instance details for the given instance and account name.com.azure.core.http.rest.Response<Instance>
getWithResponse
(String resourceGroupName, String accountName, String instanceName, com.azure.core.util.Context context) Returns instance details for the given instance and account name.void
Checks whether instance exists.com.azure.core.http.rest.Response<Void>
headWithResponse
(String resourceGroupName, String accountName, String instanceName, com.azure.core.util.Context context) Checks whether instance exists.com.azure.core.http.rest.PagedIterable<Instance>
listByAccount
(String resourceGroupName, String accountName) Returns instances for the given account name.com.azure.core.http.rest.PagedIterable<Instance>
listByAccount
(String resourceGroupName, String accountName, com.azure.core.util.Context context) Returns instances for the given account name.
-
Method Details
-
listByAccount
com.azure.core.http.rest.PagedIterable<Instance> 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<Instance> 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
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<Instance> 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
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.
-
delete
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.
-
getById
Returns instance details for the given instance and account name.- Parameters:
id
- the resource ID.- 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<Instance> getByIdWithResponse(String id, com.azure.core.util.Context context) Returns instance details for the given instance and account name.- Parameters:
id
- the resource ID.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.
-
deleteById
Deletes instance.- Parameters:
id
- the resource ID.- 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.
-
deleteByIdWithResponse
Deletes instance.- Parameters:
id
- the resource ID.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.
-
define
Begins definition for a new Instance resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Instance definition.
-