Interface HostsClient
public interface HostsClient
An instance of this class provides access to all the operations defined in HostsClient.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<HostModelInner>,
HostModelInner> beginCreate
(String resourceGroupName, String hostname, HostModelInner body) Implements host PUT method.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<HostModelInner>,
HostModelInner> beginCreate
(String resourceGroupName, String hostname, HostModelInner body, com.azure.core.util.Context context) Implements host PUT method.beginDelete
(String resourceGroupName, String hostname, Boolean force) Deletes an host.beginDelete
(String resourceGroupName, String hostname, Boolean force, com.azure.core.util.Context context) Deletes an host.Implements host PUT method.create
(String resourceGroupName, String hostname, HostModelInner body) Implements host PUT method.create
(String resourceGroupName, String hostname, HostModelInner body, com.azure.core.util.Context context) Implements host PUT method.void
Deletes an host.void
Deletes an host.void
delete
(String resourceGroupName, String hostname, Boolean force, com.azure.core.util.Context context) Deletes an host.getByResourceGroup
(String resourceGroupName, String hostname) Gets a host.com.azure.core.http.rest.Response<HostModelInner>
getByResourceGroupWithResponse
(String resourceGroupName, String hostname, com.azure.core.util.Context context) Gets a host.com.azure.core.http.rest.PagedIterable<HostModelInner>
list()
Implements GET hosts in a subscription.com.azure.core.http.rest.PagedIterable<HostModelInner>
list
(com.azure.core.util.Context context) Implements GET hosts in a subscription.com.azure.core.http.rest.PagedIterable<HostModelInner>
listByResourceGroup
(String resourceGroupName) Implements GET hosts in a resource group.com.azure.core.http.rest.PagedIterable<HostModelInner>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Implements GET hosts in a resource group.Updates a host.com.azure.core.http.rest.Response<HostModelInner>
updateWithResponse
(String resourceGroupName, String hostname, ResourcePatch body, com.azure.core.util.Context context) Updates a host.
-
Method Details
-
beginCreate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<HostModelInner>,HostModelInner> beginCreate(String resourceGroupName, String hostname, HostModelInner body) Implements host PUT method.Create Or Update host.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.body
- Request payload.- Returns:
- the
SyncPoller
for polling of define the host. - 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<HostModelInner>,HostModelInner> beginCreate(String resourceGroupName, String hostname, HostModelInner body, com.azure.core.util.Context context) Implements host PUT method.Create Or Update host.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.body
- Request payload.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of define the host. - 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
Implements host PUT method.Create Or Update host.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.body
- Request payload.- Returns:
- define the host.
- 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
Implements host PUT method.Create Or Update host.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.- Returns:
- define the host.
- 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
HostModelInner create(String resourceGroupName, String hostname, HostModelInner body, com.azure.core.util.Context context) Implements host PUT method.Create Or Update host.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.body
- Request payload.context
- The context to associate with this operation.- Returns:
- define the host.
- 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 a host.Implements host GET method.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.- Returns:
- define the host.
- 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.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<HostModelInner> getByResourceGroupWithResponse(String resourceGroupName, String hostname, com.azure.core.util.Context context) Gets a host.Implements host GET method.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.context
- The context to associate with this operation.- Returns:
- define the host 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.
-
update
Updates a host.API to update certain properties of the host resource.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.- Returns:
- define the host.
- 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<HostModelInner> updateWithResponse(String resourceGroupName, String hostname, ResourcePatch body, com.azure.core.util.Context context) Updates a host.API to update certain properties of the host resource.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.body
- Resource properties to update.context
- The context to associate with this operation.- Returns:
- define the host 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String hostname, Boolean force) Deletes an host.Implements host DELETE method.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.force
- Whether force delete was specified.- 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 hostname, Boolean force, com.azure.core.util.Context context) Deletes an host.Implements host DELETE method.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.force
- Whether force delete was specified.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
Deletes an host.Implements host DELETE method.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.force
- Whether force delete was specified.- 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 an host.Implements host DELETE method.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.- 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 hostname, Boolean force, com.azure.core.util.Context context) Deletes an host.Implements host DELETE method.
- Parameters:
resourceGroupName
- The Resource Group Name.hostname
- Name of the host.force
- Whether force delete was specified.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<HostModelInner> list()Implements GET hosts in a subscription.List of hosts in a subscription.
- Returns:
- list of Hosts 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
Implements GET hosts in a subscription.List of hosts in a subscription.
- Parameters:
context
- The context to associate with this operation.- Returns:
- list of Hosts 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<HostModelInner> listByResourceGroup(String resourceGroupName) Implements GET hosts in a resource group.List of hosts in a resource group.
- Parameters:
resourceGroupName
- The Resource Group Name.- Returns:
- list of Hosts 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<HostModelInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context) Implements GET hosts in a resource group.List of hosts in a resource group.
- Parameters:
resourceGroupName
- The Resource Group Name.context
- The context to associate with this operation.- Returns:
- list of Hosts 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.
-