Package com.azure.resourcemanager.healthcareapis.models

Interface Services

public interface Services

Resource collection API of Services.

Method Summary

Modifier and Type	Method	Description
ServicesNameAvailabilityInfo	checkNameAvailability(CheckNameAvailabilityParameters checkNameAvailabilityInputs)	Check if a service instance name is available.
com.azure.core.http.rest.Response<ServicesNameAvailabilityInfo>	checkNameAvailabilityWithResponse(CheckNameAvailabilityParameters checkNameAvailabilityInputs, com.azure.core.util.Context context)	Check if a service instance name is available.
ServicesDescription.DefinitionStages.Blank	define(String name)	Begins definition for a new ServicesDescription resource.
void	delete(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Delete a service instance.
void	deleteById(String id)	Delete a service instance.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete a service instance.
void	deleteByResourceGroup(String resourceGroupName, String resourceName)	Delete a service instance.
ServicesDescription	getById(String id)	Get the metadata of a service instance.
com.azure.core.http.rest.Response<ServicesDescription>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get the metadata of a service instance.
ServicesDescription	getByResourceGroup(String resourceGroupName, String resourceName)	Get the metadata of a service instance.
com.azure.core.http.rest.Response<ServicesDescription>	getByResourceGroupWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Get the metadata of a service instance.
com.azure.core.http.rest.PagedIterable<ServicesDescription>	list()	Get all the service instances in a subscription.
com.azure.core.http.rest.PagedIterable<ServicesDescription>	list(com.azure.core.util.Context context)	Get all the service instances in a subscription.
com.azure.core.http.rest.PagedIterable<ServicesDescription>	listByResourceGroup(String resourceGroupName)	Get all the service instances in a resource group.
com.azure.core.http.rest.PagedIterable<ServicesDescription>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Get all the service instances in a resource group.

Method Detail

getByResourceGroup

ServicesDescription getByResourceGroup(String resourceGroupName,
                                       String resourceName)

Get the metadata of a service instance.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

resourceName - The name of the service instance.

Returns:

the metadata of a service 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.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<ServicesDescription> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                      String resourceName,
                                                                                      com.azure.core.util.Context context)

Get the metadata of a service instance.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

resourceName - The name of the service instance.

context - The context to associate with this operation.

Returns:

the metadata of a service 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.

deleteByResourceGroup

void deleteByResourceGroup(String resourceGroupName,
                           String resourceName)

Delete a service instance.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

resourceName - The name of the service 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

void delete(String resourceGroupName,
            String resourceName,
            com.azure.core.util.Context context)

Delete a service instance.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

resourceName - The name of the service instance.

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<ServicesDescription> list()

Get all the service instances in a subscription.

Returns:

all the service instances 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

com.azure.core.http.rest.PagedIterable<ServicesDescription> list(com.azure.core.util.Context context)

Get all the service instances in a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

all the service instances 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

com.azure.core.http.rest.PagedIterable<ServicesDescription> listByResourceGroup(String resourceGroupName)

Get all the service instances in a resource group.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

Returns:

all the service instances 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<ServicesDescription> listByResourceGroup(String resourceGroupName,
                                                                                com.azure.core.util.Context context)

Get all the service instances in a resource group.

Parameters:

resourceGroupName - The name of the resource group that contains the service instance.

context - The context to associate with this operation.

Returns:

all the service instances 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.

checkNameAvailability

ServicesNameAvailabilityInfo checkNameAvailability(CheckNameAvailabilityParameters checkNameAvailabilityInputs)

Check if a service instance name is available.

Parameters:

checkNameAvailabilityInputs - Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.

Returns:

the properties indicating whether a given service name is available.

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.

checkNameAvailabilityWithResponse

com.azure.core.http.rest.Response<ServicesNameAvailabilityInfo> checkNameAvailabilityWithResponse(CheckNameAvailabilityParameters checkNameAvailabilityInputs,
                                                                                                  com.azure.core.util.Context context)

Check if a service instance name is available.

Parameters:

checkNameAvailabilityInputs - Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.

context - The context to associate with this operation.

Returns:

the properties indicating whether a given service name is available 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.

getById

ServicesDescription getById(String id)

Get the metadata of a service instance.

Parameters:

id - the resource ID.

Returns:

the metadata of a service 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<ServicesDescription> getByIdWithResponse(String id,
                                                                           com.azure.core.util.Context context)

Get the metadata of a service instance.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the metadata of a service 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

void deleteById(String id)

Delete a service 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

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Delete a service 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

ServicesDescription.DefinitionStages.Blank define(String name)

Begins definition for a new ServicesDescription resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ServicesDescription definition.