Topics - Get

Referentie

Service:: Event Grid

API-versie:: 2022-06-15

Een onderwerp ophalen.
Eigenschappen van een onderwerp ophalen.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep in het abonnement van de gebruiker.
subscriptionId	path	True	string	Abonnementsreferenties waarmee een Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
topicName	path	True	string	Naam van het onderwerp.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.

Antwoorden

Name

Type

Description

200 OK

OK

Other Status Codes

Foutreacties: ***

400 Ongeldige aanvraag.
500 Interne serverfout.

Voorbeelden

Topics_Get

Voorbeeldaanvraag

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

import com.azure.core.util.Context;

/** Samples for Topics GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_Get.json
     */
    /**
     * Sample code: Topics_Get.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void topicsGet(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager.topics().getByResourceGroupWithResponse("examplerg", "exampletopic2", 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

from azure.identity import DefaultAzureCredential
from azure.mgmt.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python topics_get.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.get(
        resource_group_name="examplerg",
        topic_name="exampletopic2",
    )
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_Get.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

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_Get.json
func ExampleTopicsClient_Get() {
	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)
	}
	res, err := clientFactory.NewTopicsClient().Get(ctx, "examplerg", "exampletopic2", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Topic = armeventgrid.Topic{
	// 	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

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

/**
 * This sample demonstrates how to Get properties of a topic.
 *
 * @summary Get properties of a topic.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Topics_Get.json
 */
async function topicsGet() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const topicName = "exampletopic2";
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.topics.get(resourceGroupName, topicName);
  console.log(result);
}

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

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_Get.json
// this example is just showing the usage of "Topics_Get" 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
string topicName = "exampletopic2";
bool result = await collection.ExistsAsync(topicName);

Console.WriteLine($"Succeeded: {result}");

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

Voorbeeldrespons

Statuscode:: 200

{
  "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"
}

Definities

Name	Description
ConnectionState	ConnectionState-informatie.
createdByType	Het type identiteit waarmee de resource is gemaakt.
DataResidencyBoundary	Data Residency grens van de resource.
IdentityInfo	De identiteitsgegevens voor de resource.
IdentityType	Het type beheerde identiteit dat wordt gebruikt. Het type 'SystemAssigned, UserAssigned' omvat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' wordt elke identiteit verwijderd.
InboundIpRule
InputSchema	Dit bepaalt de indeling die Event Grid moet verwachten voor binnenkomende gebeurtenissen die zijn gepubliceerd naar de Event Grid-domeinresource.
IpActionType	Actie die moet worden uitgevoerd op basis van de overeenkomst of geen overeenkomst van het Ip-masker.
JsonField	Dit wordt gebruikt om de bron van een invoerschematoewijzing voor één doelveld in het Event Grid-gebeurtenisschema uit te drukken. Dit wordt momenteel gebruikt in de toewijzingen voor de eigenschappen 'id', 'topic' en 'eventtime'. Dit vertegenwoordigt een veld in het invoer gebeurtenisschema.
JsonFieldWithDefault	Dit wordt gebruikt om de bron van een invoerschematoewijzing voor één doelveld in het Event Grid-gebeurtenisschema uit te drukken. Dit wordt momenteel gebruikt in de toewijzingen voor de eigenschappen 'subject', 'eventtype' en 'dataversion'. Dit vertegenwoordigt een veld in het invoer gebeurtenisschema samen met een standaardwaarde die moet worden gebruikt, en ten minste een van deze twee eigenschappen moet worden opgegeven.
JsonInputSchemaMapping	Hiermee kunt u publiceren naar Event Grid met behulp van een aangepast invoerschema. Dit kan worden gebruikt om eigenschappen van een aangepast JSON-schema toe te wijzen aan het Event Grid-gebeurtenisschema.
PersistedConnectionStatus	Status van de verbinding.
PrivateEndpoint	PrivateEndpoint-informatie.
PrivateEndpointConnection
PublicNetworkAccess	Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Standaard is dit ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door
ResourceProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
Topic	EventGrid-onderwerp
TopicProvisioningState	Inrichtingsstatus van het onderwerp.
UserIdentityProperties	De informatie over de gebruikersidentiteit.

ConnectionState

ConnectionState-informatie.

Name	Type	Description
actionsRequired	string	Acties vereist (indien aanwezig).
description	string	Beschrijving van de verbindingsstatus.
status	PersistedConnectionStatus	Status van de verbinding.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataResidencyBoundary

Data Residency grens van de resource.

Name	Type	Description
WithinGeopair	string
WithinRegion	string

IdentityInfo

De identiteitsgegevens voor de resource.

Name	Type	Description
principalId	string	De principal-id van de resource-id.
tenantId	string	De tenant-id van de resource.
type	IdentityType	Het type beheerde identiteit dat wordt gebruikt. Het type 'SystemAssigned, UserAssigned' omvat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' wordt elke identiteit verwijderd.
userAssignedIdentities	<string, UserIdentityProperties>	De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Deze eigenschap wordt momenteel niet gebruikt en gereserveerd voor toekomstig gebruik.

IdentityType

Het type beheerde identiteit dat wordt gebruikt. Het type 'SystemAssigned, UserAssigned' omvat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' wordt elke identiteit verwijderd.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

InboundIpRule

Name	Type	Description
action	IpActionType	Actie die moet worden uitgevoerd op basis van de overeenkomst of geen overeenkomst van het Ip-masker.
ipMask	string	IP-adres in CIDR-notatie, bijvoorbeeld 10.0.0.0/8.

InputSchema

Dit bepaalt de indeling die Event Grid moet verwachten voor binnenkomende gebeurtenissen die zijn gepubliceerd naar de Event Grid-domeinresource.

Name	Type	Description
CloudEventSchemaV1_0	string
CustomEventSchema	string
EventGridSchema	string

IpActionType

Actie die moet worden uitgevoerd op basis van de overeenkomst of geen overeenkomst van het Ip-masker.

Name	Type	Description
Allow	string

JsonField

Dit wordt gebruikt om de bron van een invoerschematoewijzing voor één doelveld in het Event Grid-gebeurtenisschema uit te drukken. Dit wordt momenteel gebruikt in de toewijzingen voor de eigenschappen 'id', 'topic' en 'eventtime'. Dit vertegenwoordigt een veld in het invoer gebeurtenisschema.

Name	Type	Description
sourceField	string	Naam van een veld in het invoer gebeurtenisschema dat moet worden gebruikt als de bron van een toewijzing.

JsonFieldWithDefault

Dit wordt gebruikt om de bron van een invoerschematoewijzing voor één doelveld in het Event Grid-gebeurtenisschema uit te drukken. Dit wordt momenteel gebruikt in de toewijzingen voor de eigenschappen 'subject', 'eventtype' en 'dataversion'. Dit vertegenwoordigt een veld in het invoer gebeurtenisschema samen met een standaardwaarde die moet worden gebruikt, en ten minste een van deze twee eigenschappen moet worden opgegeven.

Name	Type	Description
defaultValue	string	De standaardwaarde die moet worden gebruikt voor toewijzing wanneer er geen bronveld is opgegeven of als er geen eigenschap met de opgegeven naam in de nettolading van de gepubliceerde JSON-gebeurtenis staat.
sourceField	string	Naam van een veld in het invoer gebeurtenisschema dat moet worden gebruikt als de bron van een toewijzing.

JsonInputSchemaMapping

Hiermee kunt u publiceren naar Event Grid met behulp van een aangepast invoerschema. Dit kan worden gebruikt om eigenschappen van een aangepast JSON-schema toe te wijzen aan het Event Grid-gebeurtenisschema.

Name	Type	Description
inputSchemaMappingType	string: Json	Type van de aangepaste toewijzing
properties.dataVersion	JsonFieldWithDefault	De toewijzingsgegevens voor de eigenschap DataVersion van de Event Grid-gebeurtenis.
properties.eventTime	JsonField	De toewijzingsgegevens voor de eigenschap EventTime van de Event Grid-gebeurtenis.
properties.eventType	JsonFieldWithDefault	De toewijzingsgegevens voor de eigenschap EventType van de Event Grid-gebeurtenis.
properties.id	JsonField	De toewijzingsgegevens voor de eigenschap Id van de Event Grid-gebeurtenis.
properties.subject	JsonFieldWithDefault	De toewijzingsgegevens voor de eigenschap Onderwerp van de Event Grid-gebeurtenis.
properties.topic	JsonField	De toewijzingsgegevens voor de eigenschap Topic van de Event Grid-gebeurtenis.

PersistedConnectionStatus

Status van de verbinding.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint-informatie.

Name	Type	Description
id	string	De ARM-id voor het privé-eindpunt.

PrivateEndpointConnection

Name	Type	Description
id	string	Volledig gekwalificeerde id van de resource.
name	string	De naam van de resource.
properties.groupIds	string[]	GroupIds van de private link-serviceresource.
properties.privateEndpoint	PrivateEndpoint	De privé-eindpuntresource voor deze verbinding.
properties.privateLinkServiceConnectionState	ConnectionState	Details over de status van de verbinding.
properties.provisioningState	ResourceProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
type	string	Type van de resource.

PublicNetworkAccess

Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Standaard is dit ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door

Name	Type	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Inrichtingsstatus van de privé-eindpuntverbinding.

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

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

Topic

EventGrid-onderwerp

Name	Type	Default value	Description
id	string		Volledig gekwalificeerde id van de resource.
identity	IdentityInfo		Identiteitsgegevens voor de resource.
location	string		Locatie van de resource.
name	string		De naam van de resource.
properties.dataResidencyBoundary	DataResidencyBoundary		Data Residency grens van de resource.
properties.disableLocalAuth	boolean	False	Deze booleaanse waarde wordt gebruikt om lokale verificatie in of uit te schakelen. De standaardwaarde is false. Wanneer de eigenschap is ingesteld op true, wordt alleen het AAD-token gebruikt om te verifiëren of de gebruiker mag publiceren naar het onderwerp.
properties.endpoint	string		Eindpunt voor het onderwerp.
properties.inboundIpRules	InboundIpRule[]		Dit kan worden gebruikt om verkeer van specifieke IP-adressen te beperken in plaats van alle IP-adressen. Opmerking: deze worden alleen in aanmerking genomen als PublicNetworkAccess is ingeschakeld.
properties.inputSchema	InputSchema	EventGridSchema	Dit bepaalt de indeling die Event Grid moet verwachten voor binnenkomende gebeurtenissen die naar het onderwerp zijn gepubliceerd.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Hierdoor kunt u publiceren met behulp van aangepaste gebeurtenisschema's. Een InputSchemaMapping kan worden opgegeven om verschillende eigenschappen van een bronschema toe te wijzen aan verschillende vereiste eigenschappen van het EventGridEvent-schema.
properties.metricResourceId	string		Metrische resource-id voor het onderwerp.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	TopicProvisioningState		Inrichtingsstatus van het onderwerp.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Hiermee wordt bepaald of verkeer via een openbaar netwerk is toegestaan. Standaard is dit ingeschakeld. U kunt verder beperken tot specifieke IP-adressen door
systemData	systemData		De systeemmetagegevens met betrekking tot onderwerpresource.
tags	object		Tags van de resource.
type	string		Type van de resource.

TopicProvisioningState

Inrichtingsstatus van het onderwerp.

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

UserIdentityProperties

De informatie over de gebruikersidentiteit.

Name	Type	Description
clientId	string	De client-id van de door de gebruiker toegewezen identiteit.
principalId	string	De principal-id van de door de gebruiker toegewezen identiteit.