Package com.azure.resourcemanager.signalr.models

Interface SignalRCustomDomains

public interface SignalRCustomDomains

Resource collection API of SignalRCustomDomains.

Method Summary

Modifier and Type	Method	Description
CustomDomain.DefinitionStages.Blank	define(String name)	Begins definition for a new CustomDomain resource.
void	delete(String resourceGroupName, String resourceName, String name)	Delete a custom domain.
void	delete(String resourceGroupName, String resourceName, String name, com.azure.core.util.Context context)	Delete a custom domain.
void	deleteById(String id)	Delete a custom domain.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete a custom domain.
CustomDomain	get(String resourceGroupName, String resourceName, String name)	Get a custom domain.
CustomDomain	getById(String id)	Get a custom domain.
com.azure.core.http.rest.Response<CustomDomain>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get a custom domain.
com.azure.core.http.rest.Response<CustomDomain>	getWithResponse(String resourceGroupName, String resourceName, String name, com.azure.core.util.Context context)	Get a custom domain.
com.azure.core.http.rest.PagedIterable<CustomDomain>	list(String resourceGroupName, String resourceName)	List all custom domains.
com.azure.core.http.rest.PagedIterable<CustomDomain>	list(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	List all custom domains.

Method Detail

list

com.azure.core.http.rest.PagedIterable<CustomDomain> list(String resourceGroupName,
                                                          String resourceName)

List all custom domains.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName - The name of the resource.

Returns:

custom domains list 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.

list

com.azure.core.http.rest.PagedIterable<CustomDomain> list(String resourceGroupName,
                                                          String resourceName,
                                                          com.azure.core.util.Context context)

List all custom domains.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName - The name of the resource.

context - The context to associate with this operation.

Returns:

custom domains list 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

CustomDomain get(String resourceGroupName,
                 String resourceName,
                 String name)

Get a custom domain.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName - The name of the resource.

name - Custom domain name.

Returns:

a custom domain.

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<CustomDomain> getWithResponse(String resourceGroupName,
                                                                String resourceName,
                                                                String name,
                                                                com.azure.core.util.Context context)

Get a custom domain.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName - The name of the resource.

name - Custom domain name.

context - The context to associate with this operation.

Returns:

a custom domain 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.

delete

void delete(String resourceGroupName,
            String resourceName,
            String name)

Delete a custom domain.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName - The name of the resource.

name - Custom domain 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 resourceName,
            String name,
            com.azure.core.util.Context context)

Delete a custom domain.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

resourceName - The name of the resource.

name - Custom domain 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

CustomDomain getById(String id)

Get a custom domain.

Parameters:

id - the resource ID.

Returns:

a custom domain 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<CustomDomain> getByIdWithResponse(String id,
                                                                    com.azure.core.util.Context context)

Get a custom domain.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a custom domain 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 custom domain.

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 custom domain.

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

CustomDomain.DefinitionStages.Blank define(String name)

Begins definition for a new CustomDomain resource.

Parameters:

name - resource name.

Returns:

the first stage of the new CustomDomain definition.