Package com.azure.resourcemanager.eventgrid.models

Interface PartnerDestinations

public interface PartnerDestinations

Resource collection API of PartnerDestinations.

Method Summary

Modifier and Type	Method	Description
PartnerDestination	activate(String resourceGroupName, String partnerDestinationName)	Activate a newly created partner destination.
com.azure.core.http.rest.Response<PartnerDestination>	activateWithResponse(String resourceGroupName, String partnerDestinationName, com.azure.core.util.Context context)	Activate a newly created partner destination.
PartnerDestination.DefinitionStages.Blank	define(String name)	Begins definition for a new PartnerDestination resource.
void	delete(String resourceGroupName, String partnerDestinationName, com.azure.core.util.Context context)	Delete existing partner destination.
void	deleteById(String id)	Delete existing partner destination.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete existing partner destination.
void	deleteByResourceGroup(String resourceGroupName, String partnerDestinationName)	Delete existing partner destination.
PartnerDestination	getById(String id)	Get properties of a partner destination.
com.azure.core.http.rest.Response<PartnerDestination>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get properties of a partner destination.
PartnerDestination	getByResourceGroup(String resourceGroupName, String partnerDestinationName)	Get properties of a partner destination.
com.azure.core.http.rest.Response<PartnerDestination>	getByResourceGroupWithResponse(String resourceGroupName, String partnerDestinationName, com.azure.core.util.Context context)	Get properties of a partner destination.
com.azure.core.http.rest.PagedIterable<PartnerDestination>	list()	List all the partner destinations under an Azure subscription.
com.azure.core.http.rest.PagedIterable<PartnerDestination>	list(String filter, Integer top, com.azure.core.util.Context context)	List all the partner destinations under an Azure subscription.
com.azure.core.http.rest.PagedIterable<PartnerDestination>	listByResourceGroup(String resourceGroupName)	List all the partner destinations under a resource group.
com.azure.core.http.rest.PagedIterable<PartnerDestination>	listByResourceGroup(String resourceGroupName, String filter, Integer top, com.azure.core.util.Context context)	List all the partner destinations under a resource group.

Method Detail

getByResourceGroup

PartnerDestination getByResourceGroup(String resourceGroupName,
                                      String partnerDestinationName)

Get properties of a partner destination.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerDestinationName - Name of the partner destination.

Returns:

properties of a partner destination.

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<PartnerDestination> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                     String partnerDestinationName,
                                                                                     com.azure.core.util.Context context)

Get properties of a partner destination.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerDestinationName - Name of the partner destination.

context - The context to associate with this operation.

Returns:

properties of a partner destination 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 partnerDestinationName)

Delete existing partner destination.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerDestinationName - Name of the partner destination.

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

Delete existing partner destination.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerDestinationName - Name of the partner destination.

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

List all the partner destinations under an Azure subscription.

Returns:

result of the List Partner Destinations operation 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<PartnerDestination> list(String filter,
                                                                Integer top,
                                                                com.azure.core.util.Context context)

List all the partner destinations under an Azure subscription.

Parameters:

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List Partner Destinations operation 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<PartnerDestination> listByResourceGroup(String resourceGroupName)

List all the partner destinations under a resource group.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

Returns:

result of the List Partner Destinations operation 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<PartnerDestination> listByResourceGroup(String resourceGroupName,
                                                                               String filter,
                                                                               Integer top,
                                                                               com.azure.core.util.Context context)

List all the partner destinations under a resource group.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List Partner Destinations operation 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.

activate

PartnerDestination activate(String resourceGroupName,
                            String partnerDestinationName)

Activate a newly created partner destination.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerDestinationName - Name of the partner destination.

Returns:

event Grid Partner Destination.

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.

activateWithResponse

com.azure.core.http.rest.Response<PartnerDestination> activateWithResponse(String resourceGroupName,
                                                                           String partnerDestinationName,
                                                                           com.azure.core.util.Context context)

Activate a newly created partner destination.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerDestinationName - Name of the partner destination.

context - The context to associate with this operation.

Returns:

event Grid Partner Destination 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

PartnerDestination getById(String id)

Get properties of a partner destination.

Parameters:

id - the resource ID.

Returns:

properties of a partner destination 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<PartnerDestination> getByIdWithResponse(String id,
                                                                          com.azure.core.util.Context context)

Get properties of a partner destination.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

properties of a partner destination 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 existing partner destination.

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 existing partner destination.

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

PartnerDestination.DefinitionStages.Blank define(String name)

Begins definition for a new PartnerDestination resource.

Parameters:

name - resource name.

Returns:

the first stage of the new PartnerDestination definition.