Interface PartnerTopics
public interface PartnerTopics
Resource collection API of PartnerTopics.
-
Method Summary
Modifier and TypeMethodDescriptionActivate a newly created partner topic.com.azure.core.http.rest.Response<PartnerTopic>
activateWithResponse
(String resourceGroupName, String partnerTopicName, com.azure.core.util.Context context) Activate a newly created partner topic.deactivate
(String resourceGroupName, String partnerTopicName) Deactivate specific partner topic.com.azure.core.http.rest.Response<PartnerTopic>
deactivateWithResponse
(String resourceGroupName, String partnerTopicName, com.azure.core.util.Context context) Deactivate specific partner topic.Begins definition for a new PartnerTopic resource.void
Delete existing partner topic.void
deleteById
(String id) Delete existing partner topic.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Delete existing partner topic.void
deleteByResourceGroup
(String resourceGroupName, String partnerTopicName) Delete existing partner topic.Get properties of a partner topic.com.azure.core.http.rest.Response<PartnerTopic>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Get properties of a partner topic.getByResourceGroup
(String resourceGroupName, String partnerTopicName) Get properties of a partner topic.com.azure.core.http.rest.Response<PartnerTopic>
getByResourceGroupWithResponse
(String resourceGroupName, String partnerTopicName, com.azure.core.util.Context context) Get properties of a partner topic.com.azure.core.http.rest.PagedIterable<PartnerTopic>
list()
List all the partner topics under an Azure subscription.com.azure.core.http.rest.PagedIterable<PartnerTopic>
List all the partner topics under an Azure subscription.com.azure.core.http.rest.PagedIterable<PartnerTopic>
listByResourceGroup
(String resourceGroupName) List all the partner topics under a resource group.com.azure.core.http.rest.PagedIterable<PartnerTopic>
listByResourceGroup
(String resourceGroupName, String filter, Integer top, com.azure.core.util.Context context) List all the partner topics under a resource group.
-
Method Details
-
getByResourceGroup
Get properties of a partner topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.partnerTopicName
- Name of the partner topic.- Returns:
- properties of a partner topic.
- 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<PartnerTopic> getByResourceGroupWithResponse(String resourceGroupName, String partnerTopicName, com.azure.core.util.Context context) Get properties of a partner topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.partnerTopicName
- Name of the partner topic.context
- The context to associate with this operation.- Returns:
- properties of a partner topic 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
Delete existing partner topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.partnerTopicName
- Name of the partner topic.- 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
Delete existing partner topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.partnerTopicName
- Name of the partner topic.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<PartnerTopic> list()List all the partner topics under an Azure subscription.- Returns:
- result of the List Partner Topics 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<PartnerTopic> list(String filter, Integer top, com.azure.core.util.Context context) List all the partner topics 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 Topics 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
List all the partner topics under a resource group.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.- Returns:
- result of the List Partner Topics 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<PartnerTopic> listByResourceGroup(String resourceGroupName, String filter, Integer top, com.azure.core.util.Context context) List all the partner topics 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 Topics 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
Activate a newly created partner topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.partnerTopicName
- Name of the partner topic.- Returns:
- event Grid Partner Topic.
- 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<PartnerTopic> activateWithResponse(String resourceGroupName, String partnerTopicName, com.azure.core.util.Context context) Activate a newly created partner topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.partnerTopicName
- Name of the partner topic.context
- The context to associate with this operation.- Returns:
- event Grid Partner Topic 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.
-
deactivate
Deactivate specific partner topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.partnerTopicName
- Name of the partner topic.- Returns:
- event Grid Partner Topic.
- 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.
-
deactivateWithResponse
com.azure.core.http.rest.Response<PartnerTopic> deactivateWithResponse(String resourceGroupName, String partnerTopicName, com.azure.core.util.Context context) Deactivate specific partner topic.- Parameters:
resourceGroupName
- The name of the resource group within the user's subscription.partnerTopicName
- Name of the partner topic.context
- The context to associate with this operation.- Returns:
- event Grid Partner Topic 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
Get properties of a partner topic.- Parameters:
id
- the resource ID.- Returns:
- properties of a partner topic 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<PartnerTopic> getByIdWithResponse(String id, com.azure.core.util.Context context) Get properties of a partner topic.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- properties of a partner topic 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
Delete existing partner topic.- 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
Delete existing partner topic.- 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
Begins definition for a new PartnerTopic resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new PartnerTopic definition.
-