2022-01-25 08:34:47 +03:00
### YamlMime:JavaType
uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics"
name : "SystemTopics"
nameWithType : "SystemTopics"
2022-08-22 08:55:24 +03:00
summary : "Resource collection API of System<wbr>Topics."
2022-11-01 07:30:49 +03:00
syntax : "public interface **SystemTopics**"
2022-01-25 08:34:47 +03:00
methods :
2022-08-22 08:55:24 +03:00
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.define(java.lang.String)"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.define(String name)"
name : "define(String name)"
nameWithType : "SystemTopics.define(String name)"
summary : "Begins definition for a new System<wbr>Topic resource."
modifiers :
- "abstract"
parameters :
- description : "resource name."
name : "name"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
syntax : "public abstract SystemTopic.DefinitionStages.Blank define(String name)"
desc : "Begins definition for a new SystemTopic resource."
returns :
description : "the first stage of the new SystemTopic definition."
type : "<xref href=\"com.azure.resourcemanager.eventgrid.models.SystemTopic.DefinitionStages.Blank?alt=com.azure.resourcemanager.eventgrid.models.SystemTopic.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.delete(java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.delete(String resourceGroupName, String systemTopicName, Context context)"
name : "delete(String resourceGroupName, String systemTopicName, Context context)"
nameWithType : "SystemTopics.delete(String resourceGroupName, String systemTopicName, Context context)"
summary : "Delete existing system topic."
modifiers :
- "abstract"
parameters :
- description : "The name of the resource group within the user's subscription."
name : "resourceGroupName"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
- description : "Name of the system topic."
name : "systemTopicName"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
- description : "The context to associate with this operation."
name : "context"
type : "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax : "public abstract void delete(String resourceGroupName, String systemTopicName, Context context)"
desc : "Delete existing system topic."
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.deleteById(java.lang.String)"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.deleteById(String id)"
name : "deleteById(String id)"
nameWithType : "SystemTopics.deleteById(String id)"
summary : "Delete existing system topic."
modifiers :
- "abstract"
parameters :
- description : "the resource ID."
name : "id"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
syntax : "public abstract void deleteById(String id)"
desc : "Delete existing system topic."
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.deleteByIdWithResponse(String id, Context context)"
name : "deleteByIdWithResponse(String id, Context context)"
nameWithType : "SystemTopics.deleteByIdWithResponse(String id, Context context)"
summary : "Delete existing system topic."
modifiers :
- "abstract"
parameters :
- description : "the resource ID."
name : "id"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
- description : "The context to associate with this operation."
name : "context"
type : "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax : "public abstract void deleteByIdWithResponse(String id, Context context)"
desc : "Delete existing system topic."
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.deleteByResourceGroup(java.lang.String,java.lang.String)"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.deleteByResourceGroup(String resourceGroupName, String systemTopicName)"
name : "deleteByResourceGroup(String resourceGroupName, String systemTopicName)"
nameWithType : "SystemTopics.deleteByResourceGroup(String resourceGroupName, String systemTopicName)"
summary : "Delete existing system topic."
modifiers :
- "abstract"
parameters :
- description : "The name of the resource group within the user's subscription."
name : "resourceGroupName"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
- description : "Name of the system topic."
name : "systemTopicName"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
syntax : "public abstract void deleteByResourceGroup(String resourceGroupName, String systemTopicName)"
desc : "Delete existing system topic."
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.getById(java.lang.String)"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.getById(String id)"
name : "getById(String id)"
nameWithType : "SystemTopics.getById(String id)"
summary : "Get properties of a system topic."
modifiers :
- "abstract"
parameters :
- description : "the resource ID."
name : "id"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
syntax : "public abstract SystemTopic getById(String id)"
desc : "Get properties of a system topic."
returns :
description : "properties of a system topic along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type : "<xref href=\"com.azure.resourcemanager.eventgrid.models.SystemTopic?alt=com.azure.resourcemanager.eventgrid.models.SystemTopic&text=SystemTopic\" data-throw-if-not-resolved=\"False\" />"
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.getByIdWithResponse(String id, Context context)"
name : "getByIdWithResponse(String id, Context context)"
nameWithType : "SystemTopics.getByIdWithResponse(String id, Context context)"
summary : "Get properties of a system topic."
modifiers :
- "abstract"
parameters :
- description : "the resource ID."
name : "id"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
- description : "The context to associate with this operation."
name : "context"
type : "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax : "public abstract Response<SystemTopic> getByIdWithResponse(String id, Context context)"
desc : "Get properties of a system topic."
returns :
description : "properties of a system topic along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type : "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.eventgrid.models.SystemTopic?alt=com.azure.resourcemanager.eventgrid.models.SystemTopic&text=SystemTopic\" data-throw-if-not-resolved=\"False\" />>"
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.getByResourceGroup(java.lang.String,java.lang.String)"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.getByResourceGroup(String resourceGroupName, String systemTopicName)"
name : "getByResourceGroup(String resourceGroupName, String systemTopicName)"
nameWithType : "SystemTopics.getByResourceGroup(String resourceGroupName, String systemTopicName)"
summary : "Get properties of a system topic."
modifiers :
- "abstract"
parameters :
- description : "The name of the resource group within the user's subscription."
name : "resourceGroupName"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
- description : "Name of the system topic."
name : "systemTopicName"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
syntax : "public abstract SystemTopic getByResourceGroup(String resourceGroupName, String systemTopicName)"
desc : "Get properties of a system topic."
returns :
description : "properties of a system topic."
type : "<xref href=\"com.azure.resourcemanager.eventgrid.models.SystemTopic?alt=com.azure.resourcemanager.eventgrid.models.SystemTopic&text=SystemTopic\" data-throw-if-not-resolved=\"False\" />"
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.getByResourceGroupWithResponse(java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.getByResourceGroupWithResponse(String resourceGroupName, String systemTopicName, Context context)"
name : "getByResourceGroupWithResponse(String resourceGroupName, String systemTopicName, Context context)"
nameWithType : "SystemTopics.getByResourceGroupWithResponse(String resourceGroupName, String systemTopicName, Context context)"
summary : "Get properties of a system topic."
modifiers :
- "abstract"
parameters :
- description : "The name of the resource group within the user's subscription."
name : "resourceGroupName"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
- description : "Name of the system topic."
name : "systemTopicName"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
- description : "The context to associate with this operation."
name : "context"
type : "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax : "public abstract Response<SystemTopic> getByResourceGroupWithResponse(String resourceGroupName, String systemTopicName, Context context)"
desc : "Get properties of a system topic."
returns :
description : "properties of a system topic along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type : "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.eventgrid.models.SystemTopic?alt=com.azure.resourcemanager.eventgrid.models.SystemTopic&text=SystemTopic\" data-throw-if-not-resolved=\"False\" />>"
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.list()"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.list()"
name : "list()"
nameWithType : "SystemTopics.list()"
summary : "List all the system topics under an Azure subscription."
modifiers :
- "abstract"
syntax : "public abstract PagedIterable<SystemTopic> list()"
desc : "List all the system topics under an Azure subscription."
returns :
description : "result of the List System topics operation."
type : "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.eventgrid.models.SystemTopic?alt=com.azure.resourcemanager.eventgrid.models.SystemTopic&text=SystemTopic\" data-throw-if-not-resolved=\"False\" />>"
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.list(java.lang.String,java.lang.Integer,com.azure.core.util.Context)"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.list(String filter, Integer top, Context context)"
name : "list(String filter, Integer top, Context context)"
nameWithType : "SystemTopics.list(String filter, Integer top, Context context)"
summary : "List all the system topics under an Azure subscription."
modifiers :
- "abstract"
parameters :
- description : "The query used to filter the search results using OData syntax. Filtering is permitted on the\n 'name' property only and with limited number of OData operations. These operations are: the 'contains'\n function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal).\n No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE,\n 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq\n 'westus'."
name : "filter"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
- description : "The number of results to return per page for the list operation. Valid range for top parameter is 1 to\n 100. If not specified, the default number of results to be returned is 20 items per page."
name : "top"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
2022-08-22 08:55:24 +03:00
- description : "The context to associate with this operation."
name : "context"
type : "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax : "public abstract PagedIterable<SystemTopic> list(String filter, Integer top, Context context)"
desc : "List all the system topics under an Azure subscription."
returns :
description : "result of the List System topics operation."
type : "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.eventgrid.models.SystemTopic?alt=com.azure.resourcemanager.eventgrid.models.SystemTopic&text=SystemTopic\" data-throw-if-not-resolved=\"False\" />>"
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.listByResourceGroup(java.lang.String)"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.listByResourceGroup(String resourceGroupName)"
name : "listByResourceGroup(String resourceGroupName)"
nameWithType : "SystemTopics.listByResourceGroup(String resourceGroupName)"
summary : "List all the system topics under a resource group."
modifiers :
- "abstract"
parameters :
- description : "The name of the resource group within the user's subscription."
name : "resourceGroupName"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
syntax : "public abstract PagedIterable<SystemTopic> listByResourceGroup(String resourceGroupName)"
desc : "List all the system topics under a resource group."
returns :
description : "result of the List System topics operation."
type : "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.eventgrid.models.SystemTopic?alt=com.azure.resourcemanager.eventgrid.models.SystemTopic&text=SystemTopic\" data-throw-if-not-resolved=\"False\" />>"
- uid : "com.azure.resourcemanager.eventgrid.models.SystemTopics.listByResourceGroup(java.lang.String,java.lang.String,java.lang.Integer,com.azure.core.util.Context)"
fullName : "com.azure.resourcemanager.eventgrid.models.SystemTopics.listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context)"
name : "listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context)"
nameWithType : "SystemTopics.listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context)"
summary : "List all the system topics under a resource group."
modifiers :
- "abstract"
parameters :
- description : "The name of the resource group within the user's subscription."
name : "resourceGroupName"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
- description : "The query used to filter the search results using OData syntax. Filtering is permitted on the\n 'name' property only and with limited number of OData operations. These operations are: the 'contains'\n function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal).\n No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE,\n 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq\n 'westus'."
name : "filter"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
2022-08-22 08:55:24 +03:00
- description : "The number of results to return per page for the list operation. Valid range for top parameter is 1 to\n 100. If not specified, the default number of results to be returned is 20 items per page."
name : "top"
2022-09-07 07:25:44 +03:00
type : "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
2022-08-22 08:55:24 +03:00
- description : "The context to associate with this operation."
name : "context"
type : "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax : "public abstract PagedIterable<SystemTopic> listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context)"
desc : "List all the system topics under a resource group."
returns :
description : "result of the List System topics operation."
type : "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.eventgrid.models.SystemTopic?alt=com.azure.resourcemanager.eventgrid.models.SystemTopic&text=SystemTopic\" data-throw-if-not-resolved=\"False\" />>"
2022-01-25 08:34:47 +03:00
type : "interface"
2022-08-11 07:43:16 +03:00
desc : "Resource collection API of SystemTopics."
2022-01-25 08:34:47 +03:00
metadata : {}
package : "com.azure.resourcemanager.eventgrid.models"
artifact : com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.1.0