topic_types

Creates, updates, deletes, gets or lists a topic_types resource.

Overview

Name	topic_types
Type	Resource
Id	azure.event_grid.topic_types

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalEnforcedPermissions	array	Permissions which are enforced for creating and updating system topics of this this topic type.
areRegionalAndGlobalSourcesSupported	boolean	Flag to indicate that a topic type can support both regional or global system topics.
description	string	Description of the topic type.
displayName	string	Display Name for the topic type.
provider	string	Namespace of the provider of the topic type.
provisioningState	string	Provisioning state of the topic type. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
resourceRegionType	string	Region type of the resource. Known values are: "RegionalResource" and "GlobalResource". (RegionalResource, GlobalResource)
sourceResourceFormat	string	Source resource format.
supportedLocations	array	List of locations supported by this topic type.
supportedScopesForSource	array	Supported source scopes.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalEnforcedPermissions	array	Permissions which are enforced for creating and updating system topics of this this topic type.
areRegionalAndGlobalSourcesSupported	boolean	Flag to indicate that a topic type can support both regional or global system topics.
description	string	Description of the topic type.
displayName	string	Display Name for the topic type.
provider	string	Namespace of the provider of the topic type.
provisioningState	string	Provisioning state of the topic type. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
resourceRegionType	string	Region type of the resource. Known values are: "RegionalResource" and "GlobalResource". (RegionalResource, GlobalResource)
sourceResourceFormat	string	Source resource format.
supportedLocations	array	List of locations supported by this topic type.
supportedScopesForSource	array	Supported source scopes.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	topic_type_name		Get a topic type. Get information about a topic type.
list	select			List topic types. List all registered topic types.
list_event_types	exec	topic_type_name		List event types. List event types for a topic type.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
topic_type_name	string	Name of the topic type. Required.

SELECT examples

get

Get a topic type. Get information about a topic type.

SELECT
id,
name,
additionalEnforcedPermissions,
areRegionalAndGlobalSourcesSupported,
description,
displayName,
provider,
provisioningState,
resourceRegionType,
sourceResourceFormat,
supportedLocations,
supportedScopesForSource,
systemData,
type
FROM azure.event_grid.topic_types
WHERE topic_type_name = '{{ topic_type_name }}' -- required
;

list

List topic types. List all registered topic types.

SELECT
id,
name,
additionalEnforcedPermissions,
areRegionalAndGlobalSourcesSupported,
description,
displayName,
provider,
provisioningState,
resourceRegionType,
sourceResourceFormat,
supportedLocations,
supportedScopesForSource,
systemData,
type
FROM azure.event_grid.topic_types
;

Lifecycle Methods

list_event_types

List event types. List event types for a topic type.

EXEC azure.event_grid.topic_types.list_event_types 
@topic_type_name='{{ topic_type_name }}' --required
;