com.azure.resourcemanager.eventgrid.models.Topics Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-eventgrid Show documentation
Show all versions of azure-resourcemanager-eventgrid Show documentation
This package contains Microsoft Azure SDK for EventGrid Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Azure EventGrid Management Client. Package tag package-2021-10-preview.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.eventgrid.models;
import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;
/**
* Resource collection API of Topics.
*/
public interface Topics {
/**
* Get a topic.
*
* Get properties of a topic.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param topicName Name of the topic.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return properties of a topic along with {@link Response}.
*/
Response getByResourceGroupWithResponse(String resourceGroupName, String topicName, Context context);
/**
* Get a topic.
*
* Get properties of a topic.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param topicName Name of the topic.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return properties of a topic.
*/
Topic getByResourceGroup(String resourceGroupName, String topicName);
/**
* Delete a topic.
*
* Delete existing topic.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param topicName Name of the topic.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void deleteByResourceGroup(String resourceGroupName, String topicName);
/**
* Delete a topic.
*
* Delete existing topic.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param topicName Name of the topic.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void delete(String resourceGroupName, String topicName, Context context);
/**
* List topics under an Azure subscription.
*
* List all the topics under an Azure subscription.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List Topics operation as paginated response with {@link PagedIterable}.
*/
PagedIterable list();
/**
* List topics under an Azure subscription.
*
* List all the topics under an Azure subscription.
*
* @param 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'.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List Topics operation as paginated response with {@link PagedIterable}.
*/
PagedIterable list(String filter, Integer top, Context context);
/**
* List topics under a resource group.
*
* List all the topics under a resource group.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List Topics operation as paginated response with {@link PagedIterable}.
*/
PagedIterable listByResourceGroup(String resourceGroupName);
/**
* List topics under a resource group.
*
* List all the topics under a resource group.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param 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'.
* @param 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.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List Topics operation as paginated response with {@link PagedIterable}.
*/
PagedIterable listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context);
/**
* List keys for a topic.
*
* List the two keys used to publish to a topic.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param topicName Name of the topic.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return shared access keys of the Topic along with {@link Response}.
*/
Response listSharedAccessKeysWithResponse(String resourceGroupName, String topicName,
Context context);
/**
* List keys for a topic.
*
* List the two keys used to publish to a topic.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param topicName Name of the topic.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return shared access keys of the Topic.
*/
TopicSharedAccessKeys listSharedAccessKeys(String resourceGroupName, String topicName);
/**
* Regenerate key for a topic.
*
* Regenerate a shared access key for a topic.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param topicName Name of the topic.
* @param regenerateKeyRequest Request body to regenerate key.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return shared access keys of the Topic.
*/
TopicSharedAccessKeys regenerateKey(String resourceGroupName, String topicName,
TopicRegenerateKeyRequest regenerateKeyRequest);
/**
* Regenerate key for a topic.
*
* Regenerate a shared access key for a topic.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param topicName Name of the topic.
* @param regenerateKeyRequest Request body to regenerate key.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return shared access keys of the Topic.
*/
TopicSharedAccessKeys regenerateKey(String resourceGroupName, String topicName,
TopicRegenerateKeyRequest regenerateKeyRequest, Context context);
/**
* List topic event types.
*
* List event types for a topic.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param providerNamespace Namespace of the provider of the topic.
* @param resourceTypeName Name of the topic type.
* @param resourceName Name of the topic.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List Event Types operation as paginated response with {@link PagedIterable}.
*/
PagedIterable listEventTypes(String resourceGroupName, String providerNamespace, String resourceTypeName,
String resourceName);
/**
* List topic event types.
*
* List event types for a topic.
*
* @param resourceGroupName The name of the resource group within the user's subscription.
* @param providerNamespace Namespace of the provider of the topic.
* @param resourceTypeName Name of the topic type.
* @param resourceName Name of the topic.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return result of the List Event Types operation as paginated response with {@link PagedIterable}.
*/
PagedIterable listEventTypes(String resourceGroupName, String providerNamespace, String resourceTypeName,
String resourceName, Context context);
/**
* Get a topic.
*
* Get properties of a topic.
*
* @param id the resource ID.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return properties of a topic along with {@link Response}.
*/
Topic getById(String id);
/**
* Get a topic.
*
* Get properties of a topic.
*
* @param id the resource ID.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return properties of a topic along with {@link Response}.
*/
Response getByIdWithResponse(String id, Context context);
/**
* Delete a topic.
*
* Delete existing topic.
*
* @param id the resource ID.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void deleteById(String id);
/**
* Delete a topic.
*
* Delete existing topic.
*
* @param id the resource ID.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void deleteByIdWithResponse(String id, Context context);
/**
* Begins definition for a new Topic resource.
*
* @param name resource name.
* @return the first stage of the new Topic definition.
*/
Topic.DefinitionStages.Blank define(String name);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy