Topic Types - List

Service:

Event Grid

Version d'API:

2025-02-15

Répertorier les types de rubriques.
Répertorier tous les types de rubriques inscrits.

GET https://management.azure.com/providers/Microsoft.EventGrid/topicTypes?api-version=2025-02-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

Réponses

Nom	Type	Description
200 OK	TopicTypesListResult	D’ACCORD
Other Status Codes		Réponses d’erreur : *** 400 Demande incorrecte. 404 Introuvable. Erreur de serveur interne 500.

Exemples

TopicTypes_List

Exemple de requête

HTTP

GET https://management.azure.com/providers/Microsoft.EventGrid/topicTypes?api-version=2025-02-15

Java

/**
 * Samples for TopicTypes List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/TopicTypes_List.json
     */
    /**
     * Sample code: TopicTypes_List.
     * 
     * @param manager Entry point to EventGridManager.
     */
    public static void topicTypesList(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.topicTypes().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python topic_types_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EventGridManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.topic_types.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/TopicTypes_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armeventgrid_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/TopicTypes_List.json
func ExampleTopicTypesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewTopicTypesClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.TopicTypesListResult = armeventgrid.TopicTypesListResult{
		// 	Value: []*armeventgrid.TopicTypeInfo{
		// 		{
		// 			Name: to.Ptr("Microsoft.Eventhub.Namespaces"),
		// 			Type: to.Ptr("Microsoft.EventGrid/topicTypes"),
		// 			ID: to.Ptr("providers/Microsoft.EventGrid/topicTypes/Microsoft.Eventhub.Namespaces"),
		// 			Properties: &armeventgrid.TopicTypeProperties{
		// 				Description: to.Ptr("Microsoft EventHubs service events."),
		// 				DisplayName: to.Ptr("EventHubs Namespace"),
		// 				Provider: to.Ptr("Microsoft.Eventhub"),
		// 				ProvisioningState: to.Ptr(armeventgrid.TopicTypeProvisioningStateSucceeded),
		// 				ResourceRegionType: to.Ptr(armeventgrid.ResourceRegionTypeRegionalResource),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.Storage.StorageAccounts"),
		// 			Type: to.Ptr("Microsoft.EventGrid/topicTypes"),
		// 			ID: to.Ptr("providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts"),
		// 			Properties: &armeventgrid.TopicTypeProperties{
		// 				Description: to.Ptr("Microsoft Storage service events."),
		// 				DisplayName: to.Ptr("Storage Accounts"),
		// 				Provider: to.Ptr("Microsoft.Storage"),
		// 				ProvisioningState: to.Ptr(armeventgrid.TopicTypeProvisioningStateSucceeded),
		// 				ResourceRegionType: to.Ptr(armeventgrid.ResourceRegionTypeRegionalResource),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { EventGridManagementClient } = require("@azure/arm-eventgrid");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to List all registered topic types.
 *
 * @summary List all registered topic types.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/TopicTypes_List.json
 */
async function topicTypesList() {
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential);
  const resArray = new Array();
  for await (const item of client.topicTypes.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.EventGrid;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2025-02-15/examples/TopicTypes_List.json
// this example is just showing the usage of "TopicTypes_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this TopicTypeResource
TopicTypeCollection collection = tenantResource.GetTopicTypes();

// invoke the operation and iterate over the result
await foreach (TopicTypeResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    TopicTypeData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

{
  "value": [
    {
      "properties": {
        "description": "Microsoft EventHubs service events.",
        "displayName": "EventHubs Namespace",
        "provider": "Microsoft.Eventhub",
        "provisioningState": "Succeeded",
        "resourceRegionType": "RegionalResource"
      },
      "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Eventhub.Namespaces",
      "name": "Microsoft.Eventhub.Namespaces",
      "type": "Microsoft.EventGrid/topicTypes"
    },
    {
      "properties": {
        "description": "Microsoft Storage service events.",
        "displayName": "Storage Accounts",
        "provider": "Microsoft.Storage",
        "provisioningState": "Succeeded",
        "resourceRegionType": "RegionalResource"
      },
      "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts",
      "name": "Microsoft.Storage.StorageAccounts",
      "type": "Microsoft.EventGrid/topicTypes"
    }
  ]
}

Définitions

Nom	Description
ResourceRegionType	Type de région de la ressource.
TopicTypeAdditionalEnforcedPermission
TopicTypeInfo	Propriétés d’une information de type de rubrique.
TopicTypeProvisioningState	État d’approvisionnement du type de rubrique.
TopicTypesListResult	Résultat de l’opération List Topic Types
TopicTypeSourceScope	Étendues sources prises en charge.

ResourceRegionType

Énumération

Type de région de la ressource.

Valeur	Description
RegionalResource
GlobalResource

TopicTypeAdditionalEnforcedPermission

Object

Nom	Type	Description
isDataAction	boolean
permissionName	string

TopicTypeInfo

Object

Propriétés d’une information de type de rubrique.

Nom	Type	Description
id	string	Identificateur complet de la ressource.
name	string	Nom de la ressource.
properties.additionalEnforcedPermissions	TopicTypeAdditionalEnforcedPermission[]	Autorisations appliquées pour la création et la mise à jour des rubriques système de ce type de rubrique.
properties.areRegionalAndGlobalSourcesSupported	boolean	Indicateur pour indiquer qu’un type de rubrique peut prendre en charge les rubriques système régionales ou globales.
properties.description	string	Description du type de rubrique.
properties.displayName	string	Nom complet du type de rubrique.
properties.provider	string	Espace de noms du fournisseur du type de rubrique.
properties.provisioningState	TopicTypeProvisioningState	État d’approvisionnement du type de rubrique.
properties.resourceRegionType	ResourceRegionType	Type de région de la ressource.
properties.sourceResourceFormat	string	Format de ressource source.
properties.supportedLocations	string[]	Liste des emplacements pris en charge par ce type de rubrique.
properties.supportedScopesForSource	TopicTypeSourceScope[]	Étendues sources prises en charge.
type	string	Type de la ressource.

TopicTypeProvisioningState

Énumération

État d’approvisionnement du type de rubrique.

Valeur	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

TopicTypesListResult

Object

Résultat de l’opération List Topic Types

Nom	Type	Description
value	TopicTypeInfo[]	Collection de types de rubriques

TopicTypeSourceScope

Énumération

Étendues sources prises en charge.

Valeur	Description
Resource
ResourceGroup
AzureSubscription
ManagementGroup