Package com.azure.resourcemanager.datafactory.models

Interface LinkedServices

public interface LinkedServices

Resource collection API of LinkedServices.

Method Summary

Modifier and Type	Method	Description
LinkedServiceResource.DefinitionStages.Blank	define(String name)	Begins definition for a new LinkedServiceResource resource.
void	delete(String resourceGroupName, String factoryName, String linkedServiceName)	Deletes a linked service.
void	deleteById(String id)	Deletes a linked service.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a linked service.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String factoryName, String linkedServiceName, com.azure.core.util.Context context)	Deletes a linked service.
LinkedServiceResource	get(String resourceGroupName, String factoryName, String linkedServiceName)	Gets a linked service.
LinkedServiceResource	getById(String id)	Gets a linked service.
com.azure.core.http.rest.Response<LinkedServiceResource>	getByIdWithResponse(String id, String ifNoneMatch, com.azure.core.util.Context context)	Gets a linked service.
com.azure.core.http.rest.Response<LinkedServiceResource>	getWithResponse(String resourceGroupName, String factoryName, String linkedServiceName, String ifNoneMatch, com.azure.core.util.Context context)	Gets a linked service.
com.azure.core.http.rest.PagedIterable<LinkedServiceResource>	listByFactory(String resourceGroupName, String factoryName)	Lists linked services.
com.azure.core.http.rest.PagedIterable<LinkedServiceResource>	listByFactory(String resourceGroupName, String factoryName, com.azure.core.util.Context context)	Lists linked services.

Method Detail

listByFactory

com.azure.core.http.rest.PagedIterable<LinkedServiceResource> listByFactory(String resourceGroupName,
                                                                            String factoryName)

Lists linked services.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

Returns:

a list of linked service resources 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.

listByFactory

com.azure.core.http.rest.PagedIterable<LinkedServiceResource> listByFactory(String resourceGroupName,
                                                                            String factoryName,
                                                                            com.azure.core.util.Context context)

Lists linked services.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

context - The context to associate with this operation.

Returns:

a list of linked service resources 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

LinkedServiceResource get(String resourceGroupName,
                          String factoryName,
                          String linkedServiceName)

Gets a linked service.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

linkedServiceName - The linked service name.

Returns:

a linked service.

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<LinkedServiceResource> getWithResponse(String resourceGroupName,
                                                                         String factoryName,
                                                                         String linkedServiceName,
                                                                         String ifNoneMatch,
                                                                         com.azure.core.util.Context context)

Gets a linked service.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

linkedServiceName - The linked service name.

ifNoneMatch - ETag of the linked service entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

context - The context to associate with this operation.

Returns:

a linked service 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 factoryName,
            String linkedServiceName)

Deletes a linked service.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

linkedServiceName - The linked service 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.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String factoryName,
                                                           String linkedServiceName,
                                                           com.azure.core.util.Context context)

Deletes a linked service.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

linkedServiceName - The linked service name.

context - The context to associate with this operation.

Returns:

the 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

LinkedServiceResource getById(String id)

Gets a linked service.

Parameters:

id - the resource ID.

Returns:

a linked service 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<LinkedServiceResource> getByIdWithResponse(String id,
                                                                             String ifNoneMatch,
                                                                             com.azure.core.util.Context context)

Gets a linked service.

Parameters:

id - the resource ID.

ifNoneMatch - ETag of the linked service entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

context - The context to associate with this operation.

Returns:

a linked service 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)

Deletes a linked service.

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

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               com.azure.core.util.Context context)

Deletes a linked service.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

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

define

LinkedServiceResource.DefinitionStages.Blank define(String name)

Begins definition for a new LinkedServiceResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new LinkedServiceResource definition.