Topics - List By Resource Group

Service:

Event Grid

API Version:

2022-06-15

Répertorier les rubriques sous un groupe de ressources.
Répertorier toutes les rubriques sous un groupe de ressources.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics?api-version=2022-06-15

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics?api-version=2022-06-15&$filter={$filter}&$top={$top}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources dans l’abonnement de l’utilisateur.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API à utiliser avec la demande du client.
$filter	query		string	Requête utilisée pour filtrer les résultats de la recherche à l’aide de la syntaxe OData. Le filtrage est autorisé sur la propriété « name » uniquement et avec un nombre limité d’opérations OData. Ces opérations sont : la fonction « contains » ainsi que les opérations logiques suivantes : not, and, ou, eq (pour égal) et ne (pour non égal). Aucune opération arithmétique n’est prise en charge. Voici un exemple de filtre valide : $filter=contains(namE, 'PATTERN') et name ne 'PATTERN-1'. L’exemple de filtre suivant n’est pas valide : $filter=location eq 'westus'.
$top	query		integer int32	Nombre de résultats à retourner par page pour l’opération de liste. La plage valide pour le paramètre supérieur est comprise entre 1 et 100. S’il n’est pas spécifié, le nombre par défaut de résultats à retourner est de 20 éléments par page.

Réponses

Nom	Type	Description
200 OK	TopicsListResult	Ok
Other Status Codes		Réponses d’erreur : *** 400 Requête incorrecte. 500 Erreur interne du serveur.

Exemples

Topics_ListByResourceGroup

Sample Request

HTTP

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics?api-version=2022-06-15

Java

import com.azure.core.util.Context;

/** Samples for Topics ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_ListByResourceGroup.json
     */
    /**
     * Sample code: Topics_ListByResourceGroup.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void topicsListByResourceGroup(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.topics().listByResourceGroup("examplerg", null, null, 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 topics_list_by_resource_group.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="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.topics.list_by_resource_group(
        resource_group_name="examplerg",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_ListByResourceGroup.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/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_ListByResourceGroup.json
func ExampleTopicsClient_NewListByResourceGroupPager() {
	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.NewTopicsClient().NewListByResourceGroupPager("examplerg", &armeventgrid.TopicsClientListByResourceGroupOptions{Filter: nil,
		Top: 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.TopicsListResult = armeventgrid.TopicsListResult{
		// 	Value: []*armeventgrid.Topic{
		// 		{
		// 			Name: to.Ptr("exampletopic1"),
		// 			Type: to.Ptr("Microsoft.EventGrid/topics"),
		// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1"),
		// 			Location: to.Ptr("westus2"),
		// 			Tags: map[string]*string{
		// 				"tag1": to.Ptr("value1"),
		// 				"tag2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armeventgrid.TopicProperties{
		// 				Endpoint: to.Ptr("https://exampletopic1.westus2-1.eventgrid.azure.net/api/events"),
		// 				ProvisioningState: to.Ptr(armeventgrid.TopicProvisioningStateSucceeded),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("exampletopic2"),
		// 			Type: to.Ptr("Microsoft.EventGrid/topics"),
		// 			ID: to.Ptr("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2"),
		// 			Location: to.Ptr("westcentralus"),
		// 			Tags: map[string]*string{
		// 				"tag1": to.Ptr("value1"),
		// 				"tag2": to.Ptr("value2"),
		// 			},
		// 			Properties: &armeventgrid.TopicProperties{
		// 				Endpoint: to.Ptr("https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events"),
		// 				ProvisioningState: to.Ptr(armeventgrid.TopicProvisioningStateSucceeded),
		// 			},
		// 	}},
		// }
	}
}

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");

/**
 * This sample demonstrates how to List all the topics under a resource group.
 *
 * @summary List all the topics under a resource group.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_ListByResourceGroup.json
 */
async function topicsListByResourceGroup() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.topics.listByResourceGroup(resourceGroupName)) {
    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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.EventGrid;
using Azure.ResourceManager.EventGrid.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_ListByResourceGroup.json
// this example is just showing the usage of "Topics_ListByResourceGroup" 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);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this EventGridTopicResource
EventGridTopicCollection collection = resourceGroupResource.GetEventGridTopics();

// invoke the operation and iterate over the result
await foreach (EventGridTopicResource 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
    EventGridTopicData 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

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
      "location": "westus2",
      "name": "exampletopic1",
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      },
      "type": "Microsoft.EventGrid/topics"
    },
    {
      "properties": {
        "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2",
      "location": "westcentralus",
      "name": "exampletopic2",
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      },
      "type": "Microsoft.EventGrid/topics"
    }
  ]
}

Définitions

Nom	Description
ConnectionState	Informations ConnectionState.
createdByType	Type d’identité qui a créé la ressource.
DataResidencyBoundary	Data Residency limite de la ressource.
IdentityInfo	Informations d’identité pour la ressource.
IdentityType	Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité.
InboundIpRule
InputSchema	Cela détermine le format auquel Event Grid doit s’attendre pour les événements entrants publiés sur la ressource de domaine Event Grid.
IpActionType	Action à effectuer en fonction de la correspondance ou de l’absence de correspondance du masque Ip.
JsonField	Il est utilisé pour exprimer la source d’un mappage de schéma d’entrée pour un champ cible unique dans le schéma d’événement Event Grid. Ceci est actuellement utilisé dans les mappages pour les propriétés « id », « topic » et « eventtime ». Cela représente un champ dans le schéma d’événement d’entrée.
JsonFieldWithDefault	Il est utilisé pour exprimer la source d’un mappage de schéma d’entrée pour un champ cible unique dans le schéma d’événement Event Grid. Ceci est actuellement utilisé dans les mappages pour les propriétés « subject », « eventtype » et « dataversion ». Cela représente un champ dans le schéma d’événement d’entrée avec une valeur par défaut à utiliser, et au moins une de ces deux propriétés doit être fournie.
JsonInputSchemaMapping	Cela permet la publication sur Event Grid à l’aide d’un schéma d’entrée personnalisé. Il peut être utilisé pour mapper les propriétés d’un schéma JSON d’entrée personnalisé au schéma d’événement Event Grid.
PersistedConnectionStatus	État de la connexion.
PrivateEndpoint	Informations privateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant
ResourceProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
Topic	Rubrique EventGrid
TopicProvisioningState	État d’approvisionnement de la rubrique.
TopicsListResult	Résultat de l’opération Répertorier les rubriques
UserIdentityProperties	Informations sur l’identité de l’utilisateur.

ConnectionState

Informations ConnectionState.

Nom	Type	Description
actionsRequired	string	Actions requises (le cas échéant).
description	string	Description de l’état de la connexion.
status	PersistedConnectionStatus	État de la connexion.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataResidencyBoundary

Data Residency limite de la ressource.

Nom	Type	Description
WithinGeopair	string
WithinRegion	string

IdentityInfo

Informations d’identité pour la ressource.

Nom	Type	Description
principalId	string	ID principal de l’identité de ressource.
tenantId	string	ID de locataire de la ressource.
type	IdentityType	Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité.
userAssignedIdentities	<string,  UserIdentityProperties>	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». Cette propriété n’est actuellement pas utilisée et réservée pour une utilisation ultérieure.

IdentityType

Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité.

Nom	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

InboundIpRule

Nom	Type	Description
action	IpActionType	Action à effectuer en fonction de la correspondance ou de l’absence de correspondance du masque Ip.
ipMask	string	Adresse IP en notation CIDR, par exemple, 10.0.0.0/8.

InputSchema

Cela détermine le format auquel Event Grid doit s’attendre pour les événements entrants publiés sur la ressource de domaine Event Grid.

Nom	Type	Description
CloudEventSchemaV1_0	string
CustomEventSchema	string
EventGridSchema	string

IpActionType

Action à effectuer en fonction de la correspondance ou de l’absence de correspondance du masque Ip.

Nom	Type	Description
Allow	string

JsonField

Il est utilisé pour exprimer la source d’un mappage de schéma d’entrée pour un champ cible unique dans le schéma d’événement Event Grid. Ceci est actuellement utilisé dans les mappages pour les propriétés « id », « topic » et « eventtime ». Cela représente un champ dans le schéma d’événement d’entrée.

Nom	Type	Description
sourceField	string	Nom d’un champ dans le schéma d’événement d’entrée qui doit être utilisé comme source d’un mappage.

JsonFieldWithDefault

Il est utilisé pour exprimer la source d’un mappage de schéma d’entrée pour un champ cible unique dans le schéma d’événement Event Grid. Ceci est actuellement utilisé dans les mappages pour les propriétés « subject », « eventtype » et « dataversion ». Cela représente un champ dans le schéma d’événement d’entrée avec une valeur par défaut à utiliser, et au moins une de ces deux propriétés doit être fournie.

Nom	Type	Description
defaultValue	string	Valeur par défaut à utiliser pour le mappage lorsqu’un Champ source n’est pas fourni ou s’il n’existe aucune propriété avec le nom spécifié dans la charge utile d’événement JSON publiée.
sourceField	string	Nom d’un champ dans le schéma d’événement d’entrée qui doit être utilisé comme source d’un mappage.

JsonInputSchemaMapping

Cela permet la publication sur Event Grid à l’aide d’un schéma d’entrée personnalisé. Il peut être utilisé pour mapper les propriétés d’un schéma JSON d’entrée personnalisé au schéma d’événement Event Grid.

Nom	Type	Description
inputSchemaMappingType	string: Json	Type du mappage personnalisé
properties.dataVersion	JsonFieldWithDefault	Informations de mappage pour la propriété DataVersion de l’événement Event Grid.
properties.eventTime	JsonField	Informations de mappage pour la propriété EventTime de l’événement Event Grid.
properties.eventType	JsonFieldWithDefault	Informations de mappage pour la propriété EventType de l’événement Event Grid.
properties.id	JsonField	Informations de mappage pour la propriété Id de l’événement Event Grid.
properties.subject	JsonFieldWithDefault	Informations de mappage pour la propriété Subject de l’événement Event Grid.
properties.topic	JsonField	Informations de mappage pour la propriété Topic de l’événement Event Grid.

PersistedConnectionStatus

État de la connexion.

Nom	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

Informations privateEndpoint.

Nom	Type	Description
id	string	Identificateur ARM pour le point de terminaison privé.

PrivateEndpointConnection

Nom	Type	Description
id	string	Identificateur complet de la ressource.
name	string	Nom de la ressource.
properties.groupIds	string[]	GroupIds de la ressource de service private link.
properties.privateEndpoint	PrivateEndpoint	Ressource de point de terminaison privé pour cette connexion.
properties.privateLinkServiceConnectionState	ConnectionState	Détails sur l’état de la connexion.
properties.provisioningState	ResourceProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
type	string	Type de la ressource.

PublicNetworkAccess

Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant

Nom	Type	Description
Disabled	string
Enabled	string

ResourceProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

Nom	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Topic

Rubrique EventGrid

Nom	Type	Valeur par défaut	Description
id	string		Identificateur complet de la ressource.
identity	IdentityInfo		Informations d’identité pour la ressource.
location	string		Emplacement de la ressource.
name	string		Nom de la ressource.
properties.dataResidencyBoundary	DataResidencyBoundary		Data Residency limite de la ressource.
properties.disableLocalAuth	boolean	False	Cette valeur booléenne est utilisée pour activer ou désactiver l’authentification locale. La valeur par défaut est false. Lorsque la propriété a la valeur true, seul le jeton AAD est utilisé pour s’authentifier si l’utilisateur est autorisé à publier dans la rubrique.
properties.endpoint	string		Point de terminaison de la rubrique.
properties.inboundIpRules	InboundIpRule[]		Cela peut être utilisé pour limiter le trafic provenant d’adresses IP spécifiques au lieu de toutes les adresses IP. Remarque : Celles-ci sont prises en compte uniquement si PublicNetworkAccess est activé.
properties.inputSchema	InputSchema	EventGridSchema	Cela détermine le format auquel Event Grid doit s’attendre pour les événements entrants publiés dans la rubrique.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Cela permet la publication à l’aide de schémas d’événements personnalisés. Un InputSchemaMapping peut être spécifié pour mapper différentes propriétés d’un schéma source à différentes propriétés requises du schéma EventGridEvent.
properties.metricResourceId	string		ID de ressource de métrique pour la rubrique.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	TopicProvisioningState		État d’approvisionnement de la rubrique.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, il est activé. Vous pouvez limiter davantage les adresses IP spécifiques en configurant
systemData	systemData		Métadonnées système relatives à la ressource Topic.
tags	object		Étiquettes de la ressource.
type	string		Type de la ressource.

TopicProvisioningState

État d’approvisionnement de la rubrique.

Nom	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

TopicsListResult

Résultat de l’opération Répertorier les rubriques

Nom	Type	Description
nextLink	string	Lien vers la page suivante de rubriques
value	Topic[]	Collection de rubriques

UserIdentityProperties

Informations sur l’identité de l’utilisateur.

Nom	Type	Description
clientId	string	ID client de l’identité affectée par l’utilisateur.
principalId	string	ID principal de l’identité affectée par l’utilisateur.