Topics - Get

Tjänst:

Event Grid

API-version:

2022-06-15

Hämta ett ämne.
Hämta egenskaper för ett ämne.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen i användarens prenumeration.
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar en Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
topicName	path	True	string	Namnet på ämnet.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran.

Svar

Name	Typ	Description
200 OK	Topic	OK
Other Status Codes		Felsvar: *** 400 Felaktig begäran. 500 Internt serverfel.

Exempel

Topics_Get

Exempelbegäran

HTTP

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

Java

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

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_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

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_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

JavaScript

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

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_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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
ConnectionState	ConnectionState-information.
createdByType	Den typ av identitet som skapade resursen.
DataResidencyBoundary	Data Residency resursens gräns.
IdentityInfo	Identitetsinformationen för resursen.
IdentityType	Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter.
InboundIpRule
InputSchema	Detta avgör vilket format Event Grid ska förvänta sig för inkommande händelser som publicerats till Event Grid-domänresursen.
IpActionType	Åtgärd som ska utföras baserat på matchningen eller ingen matchning för IpMask.
JsonField	Detta används för att uttrycka källan för en mappning av indatascheman för ett enda målfält i Event Grid-händelseschemat. Detta används för närvarande i mappningarna för egenskaperna "id", "topic" och "eventtime". Detta representerar ett fält i indatahändelseschemat.
JsonFieldWithDefault	Detta används för att uttrycka källan för en mappning av indatascheman för ett enda målfält i Event Grid-händelseschemat. Detta används för närvarande i mappningarna för egenskaperna "subject", "eventtype" och "dataversion". Detta representerar ett fält i indatahändelseschemat tillsammans med ett standardvärde som ska användas, och minst en av dessa två egenskaper bör anges.
JsonInputSchemaMapping	På så sätt kan du publicera till Event Grid med hjälp av ett anpassat indataschema. Detta kan användas för att mappa egenskaper från ett anpassat JSON-indataschema till Event Grid-händelseschemat.
PersistedConnectionStatus	Status för anslutningen.
PrivateEndpoint	PrivateEndpoint-information.
PrivateEndpointConnection
PublicNetworkAccess	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
ResourceProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
systemData	Metadata som rör skapande och senaste ändring av resursen.
Topic	EventGrid-ämne
TopicProvisioningState	Etableringstillstånd för ämnet.
UserIdentityProperties	Information om användaridentiteten.

ConnectionState

ConnectionState-information.

Name	Typ	Description
actionsRequired	string	Åtgärder som krävs (om det finns några).
description	string	Beskrivning av anslutningstillståndet.
status	PersistedConnectionStatus	Status för anslutningen.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataResidencyBoundary

Data Residency resursens gräns.

Name	Typ	Description
WithinGeopair	string
WithinRegion	string

IdentityInfo

Identitetsinformationen för resursen.

Name	Typ	Description
principalId	string	Huvud-ID för resursidentitet.
tenantId	string	Klientorganisations-ID för resursen.
type	IdentityType	Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter.
userAssignedIdentities	<string,  UserIdentityProperties>	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Den här egenskapen används för närvarande inte och är reserverad för framtida användning.

IdentityType

Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter.

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

InboundIpRule

Name	Typ	Description
action	IpActionType	Åtgärd som ska utföras baserat på matchningen eller ingen matchning för IpMask.
ipMask	string	IP-adress i CIDR-notation, t.ex. 10.0.0.0/8.

InputSchema

Detta avgör vilket format Event Grid ska förvänta sig för inkommande händelser som publicerats till Event Grid-domänresursen.

Name	Typ	Description
CloudEventSchemaV1_0	string
CustomEventSchema	string
EventGridSchema	string

IpActionType

Åtgärd som ska utföras baserat på matchningen eller ingen matchning för IpMask.

Name	Typ	Description
Allow	string

JsonField

Detta används för att uttrycka källan för en mappning av indatascheman för ett enda målfält i Event Grid-händelseschemat. Detta används för närvarande i mappningarna för egenskaperna "id", "topic" och "eventtime". Detta representerar ett fält i indatahändelseschemat.

Name	Typ	Description
sourceField	string	Namnet på ett fält i indatahändelseschemat som ska användas som källa för en mappning.

JsonFieldWithDefault

Detta används för att uttrycka källan för en mappning av indatascheman för ett enda målfält i Event Grid-händelseschemat. Detta används för närvarande i mappningarna för egenskaperna "subject", "eventtype" och "dataversion". Detta representerar ett fält i indatahändelseschemat tillsammans med ett standardvärde som ska användas, och minst en av dessa två egenskaper bör anges.

Name	Typ	Description
defaultValue	string	Standardvärdet som ska användas för mappning när ett SourceField inte anges eller om det inte finns någon egenskap med det angivna namnet i den publicerade JSON-händelsenyttolasten.
sourceField	string	Namnet på ett fält i indatahändelseschemat som ska användas som källa för en mappning.

JsonInputSchemaMapping

På så sätt kan du publicera till Event Grid med hjälp av ett anpassat indataschema. Detta kan användas för att mappa egenskaper från ett anpassat JSON-indataschema till Event Grid-händelseschemat.

Name	Typ	Description
inputSchemaMappingType	string: Json	Typ av anpassad mappning
properties.dataVersion	JsonFieldWithDefault	Mappningsinformationen för egenskapen DataVersion för Event Grid-händelsen.
properties.eventTime	JsonField	Mappningsinformationen för eventtime-egenskapen för Event Grid-händelsen.
properties.eventType	JsonFieldWithDefault	Mappningsinformationen för eventtype-egenskapen för Event Grid-händelsen.
properties.id	JsonField	Mappningsinformationen för ID-egenskapen för Event Grid-händelsen.
properties.subject	JsonFieldWithDefault	Mappningsinformationen för egenskapen Ämne för Event Grid-händelsen.
properties.topic	JsonField	Mappningsinformationen för egenskapen Topic för Event Grid-händelsen.

PersistedConnectionStatus

Status för anslutningen.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint-information.

Name	Typ	Description
id	string	ARM-identifieraren för privat slutpunkt.

PrivateEndpointConnection

Name	Typ	Description
id	string	Fullständigt kvalificerad identifierare för resursen.
name	string	Namn på resursen.
properties.groupIds	string[]	GroupIds från private link-tjänstresursen.
properties.privateEndpoint	PrivateEndpoint	Den privata slutpunktsresursen för den här anslutningen.
properties.privateLinkServiceConnectionState	ConnectionState	Information om anslutningens tillstånd.
properties.provisioningState	ResourceProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
type	string	Typ av resurs.

PublicNetworkAccess

Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera

Name	Typ	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Etableringstillstånd för den privata slutpunktsanslutningen.

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

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Topic

EventGrid-ämne

Name	Typ	Standardvärde	Description
id	string		Fullständigt kvalificerad identifierare för resursen.
identity	IdentityInfo		Identitetsinformation för resursen.
location	string		Platsen för resursen.
name	string		Namn på resursen.
properties.dataResidencyBoundary	DataResidencyBoundary		Data Residency resursens gräns.
properties.disableLocalAuth	boolean	False	Det här booleska värdet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är false. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till ämnet.
properties.endpoint	string		Slutpunkt för ämnet.
properties.inboundIpRules	InboundIpRule[]		Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa beaktas endast om PublicNetworkAccess är aktiverat.
properties.inputSchema	InputSchema	EventGridSchema	Detta avgör vilket format Event Grid ska förvänta sig för inkommande händelser som publiceras i ämnet.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Detta möjliggör publicering med hjälp av anpassade händelsescheman. En InputSchemaMapping kan anges för att mappa olika egenskaper för ett källschema till olika obligatoriska egenskaper för EventGridEvent-schemat.
properties.metricResourceId	string		Måttresurs-ID för ämnet.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	TopicProvisioningState		Etableringstillstånd för ämnet.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
systemData	systemData		Systemmetadata som relaterar till ämnesresursen.
tags	object		Taggar för resursen.
type	string		Typ av resurs.

TopicProvisioningState

Etableringstillstånd för ämnet.

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

UserIdentityProperties

Information om användaridentiteten.

Name	Typ	Description
clientId	string	Klient-ID för användartilldelad identitet.
principalId	string	Huvud-ID för användartilldelad identitet.