Interface OrchestratorInstanceServices
public interface OrchestratorInstanceServices
Resource collection API of OrchestratorInstanceServices.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Orchestrator resource.void
Deletes the Orchestrator Instance.void
delete
(String resourceGroupName, String resourceName, Boolean forceDelete, com.azure.core.util.Context context) Deletes the Orchestrator Instance.void
deleteById
(String id) Deletes the Orchestrator Instance.void
deleteByIdWithResponse
(String id, Boolean forceDelete, com.azure.core.util.Context context) Deletes the Orchestrator Instance.Gets details about the orchestrator instance.com.azure.core.http.rest.Response<Orchestrator>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets details about the orchestrator instance.getByResourceGroup
(String resourceGroupName, String resourceName) Gets details about the orchestrator instance.com.azure.core.http.rest.Response<Orchestrator>
getByResourceGroupWithResponse
(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Gets details about the orchestrator instance.com.azure.core.http.rest.PagedIterable<Orchestrator>
list()
Get all the orchestratorInstance resources in a subscription.com.azure.core.http.rest.PagedIterable<Orchestrator>
list
(com.azure.core.util.Context context) Get all the orchestratorInstance resources in a subscription.com.azure.core.http.rest.PagedIterable<Orchestrator>
listByResourceGroup
(String resourceGroupName) Get all the OrchestratorInstances resources in a resource group.com.azure.core.http.rest.PagedIterable<Orchestrator>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Get all the OrchestratorInstances resources in a resource group.
-
Method Details
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<Orchestrator> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Gets details about the orchestrator instance.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.context
- The context to associate with this operation.- Returns:
- details about the orchestrator instance 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.
-
getByResourceGroup
Gets details about the orchestrator instance.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.- Returns:
- details about the orchestrator instance.
- 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 the Orchestrator Instance.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.- 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 resourceName, Boolean forceDelete, com.azure.core.util.Context context) Deletes the Orchestrator Instance.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.forceDelete
- Force delete resource.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.
-
list
com.azure.core.http.rest.PagedIterable<Orchestrator> list()Get all the orchestratorInstance resources in a subscription.- Returns:
- all the orchestratorInstance resources in a subscription 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.
-
list
Get all the orchestratorInstance resources in a subscription.- Parameters:
context
- The context to associate with this operation.- Returns:
- all the orchestratorInstance resources in a subscription 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.
-
listByResourceGroup
Get all the OrchestratorInstances resources in a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.- Returns:
- all the OrchestratorInstances resources in a resource group 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.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<Orchestrator> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context) Get all the OrchestratorInstances resources in a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.context
- The context to associate with this operation.- Returns:
- all the OrchestratorInstances resources in a resource group 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.
-
getById
Gets details about the orchestrator instance.- Parameters:
id
- the resource ID.- Returns:
- details about the orchestrator instance 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<Orchestrator> getByIdWithResponse(String id, com.azure.core.util.Context context) Gets details about the orchestrator instance.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- details about the orchestrator instance 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 the Orchestrator 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 the Orchestrator Instance.- Parameters:
id
- the resource ID.forceDelete
- Force delete resource.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 Orchestrator resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Orchestrator definition.
-