Package com.azure.resourcemanager.servicelinker.models

Interface Linkers

public interface Linkers

Resource collection API of Linkers.

Method Summary

Modifier and Type	Method	Description
LinkerResource.DefinitionStages.Blank	define(String name)	Begins definition for a new LinkerResource resource.
void	delete(String resourceUri, String linkerName, com.azure.core.util.Context context)	Delete a link.
void	deleteById(String id)	Delete a link.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete a link.
void	deleteByResourceGroup(String resourceUri, String linkerName)	Delete a link.
LinkerResource	get(String resourceUri, String linkerName)	Returns Linker resource for a given name.
LinkerResource	getById(String id)	Returns Linker resource for a given name.
com.azure.core.http.rest.Response<LinkerResource>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Returns Linker resource for a given name.
com.azure.core.http.rest.Response<LinkerResource>	getWithResponse(String resourceUri, String linkerName, com.azure.core.util.Context context)	Returns Linker resource for a given name.
com.azure.core.http.rest.PagedIterable<LinkerResource>	list(String resourceUri)	Returns list of Linkers which connects to the resource.
com.azure.core.http.rest.PagedIterable<LinkerResource>	list(String resourceUri, com.azure.core.util.Context context)	Returns list of Linkers which connects to the resource.
SourceConfigurationResult	listConfigurations(String resourceUri, String linkerName)	list source configurations for a linker.
com.azure.core.http.rest.Response<SourceConfigurationResult>	listConfigurationsWithResponse(String resourceUri, String linkerName, com.azure.core.util.Context context)	list source configurations for a linker.
ValidateOperationResult	validate(String resourceUri, String linkerName)	Validate a link.
ValidateOperationResult	validate(String resourceUri, String linkerName, com.azure.core.util.Context context)	Validate a link.

Method Detail

list

com.azure.core.http.rest.PagedIterable<LinkerResource> list(String resourceUri)

Returns list of Linkers which connects to the resource.

Parameters:

resourceUri - The fully qualified Azure Resource manager identifier of the resource to be connected.

Returns:

the list of Linker 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<LinkerResource> list(String resourceUri,
                                                            com.azure.core.util.Context context)

Returns list of Linkers which connects to the resource.

Parameters:

resourceUri - The fully qualified Azure Resource manager identifier of the resource to be connected.

context - The context to associate with this operation.

Returns:

the list of Linker 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

LinkerResource get(String resourceUri,
                   String linkerName)

Returns Linker resource for a given name.

Parameters:

resourceUri - The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName - The name Linker resource.

Returns:

linker of source and target resource.

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<LinkerResource> getWithResponse(String resourceUri,
                                                                  String linkerName,
                                                                  com.azure.core.util.Context context)

Returns Linker resource for a given name.

Parameters:

resourceUri - The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName - The name Linker resource.

context - The context to associate with this operation.

Returns:

linker of source and target resource 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 resourceUri,
                           String linkerName)

Delete a link.

Parameters:

resourceUri - The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName - The name Linker resource.

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 resourceUri,
            String linkerName,
            com.azure.core.util.Context context)

Delete a link.

Parameters:

resourceUri - The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName - The name Linker 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.

validate

ValidateOperationResult validate(String resourceUri,
                                 String linkerName)

Validate a link.

Parameters:

resourceUri - The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName - The name Linker resource.

Returns:

the validation operation result for a linker.

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.

validate

ValidateOperationResult validate(String resourceUri,
                                 String linkerName,
                                 com.azure.core.util.Context context)

Validate a link.

Parameters:

resourceUri - The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName - The name Linker resource.

context - The context to associate with this operation.

Returns:

the validation operation result for a linker.

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.

listConfigurations

SourceConfigurationResult listConfigurations(String resourceUri,
                                             String linkerName)

list source configurations for a linker.

Parameters:

resourceUri - The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName - The name Linker resource.

Returns:

configurations for source resource, include appSettings, connectionString and serviceBindings.

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.

listConfigurationsWithResponse

com.azure.core.http.rest.Response<SourceConfigurationResult> listConfigurationsWithResponse(String resourceUri,
                                                                                            String linkerName,
                                                                                            com.azure.core.util.Context context)

list source configurations for a linker.

Parameters:

resourceUri - The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName - The name Linker resource.

context - The context to associate with this operation.

Returns:

configurations for source resource, include appSettings, connectionString and serviceBindings 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

LinkerResource getById(String id)

Returns Linker resource for a given name.

Parameters:

id - the resource ID.

Returns:

linker of source and target resource 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<LinkerResource> getByIdWithResponse(String id,
                                                                      com.azure.core.util.Context context)

Returns Linker resource for a given name.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

linker of source and target resource 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 link.

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 link.

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

LinkerResource.DefinitionStages.Blank define(String name)

Begins definition for a new LinkerResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new LinkerResource definition.