Topics - Get

Service:

Event Grid

API Version:

2022-06-15

Uzyskaj temat.
Pobieranie właściwości tematu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji użytkownika.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
topicName	path	True	string	Nazwa tematu.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Topic	OK
Other Status Codes		Odpowiedzi na błędy: *** 400 Nieprawidłowe żądanie. 500 Wewnętrzny błąd serwera.

Przykłady

Topics_Get

Sample Request

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

Sample Response

Status code:

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

Definicje

Nazwa	Opis
ConnectionState	Informacje o stanie połączenia.
createdByType	Typ tożsamości, która utworzyła zasób.
DataResidencyBoundary	Data Residency granicę zasobu.
IdentityInfo	Informacje o tożsamości zasobu.
IdentityType	Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie dowolnej tożsamości.
InboundIpRule
InputSchema	Określa to format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących publikowanych w zasobie domeny usługi Event Grid.
IpActionType	Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask.
JsonField	Służy to do wyrażania źródła mapowania schematu wejściowego dla pojedynczego pola docelowego w schemacie zdarzeń usługi Event Grid. Jest to obecnie używane w mapowaniach właściwości "id", "topic" i "eventtime". Reprezentuje to pole w schemacie zdarzeń wejściowych.
JsonFieldWithDefault	Służy to do wyrażania źródła mapowania schematu wejściowego dla pojedynczego pola docelowego w schemacie zdarzeń usługi Event Grid. Jest to obecnie używane w mapowaniach właściwości "subject", "eventtype" i "dataversion". Reprezentuje to pole w schemacie zdarzeń wejściowych wraz z wartością domyślną, która ma być używana, i należy podać co najmniej jedną z tych dwóch właściwości.
JsonInputSchemaMapping	Umożliwia to publikowanie w usłudze Event Grid przy użyciu niestandardowego schematu wejściowego. Może to służyć do mapowania właściwości z niestandardowego schematu wejściowego JSON na schemat zdarzeń usługi Event Grid.
PersistedConnectionStatus	Stan połączenia.
PrivateEndpoint	Informacje dotyczące prywatnego punktu końcowego.
PrivateEndpointConnection
PublicNetworkAccess	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest ona włączona. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując
ResourceProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
Topic	EventGrid — temat
TopicProvisioningState	Stan aprowizacji tematu.
UserIdentityProperties	Informacje o tożsamości użytkownika.

ConnectionState

Informacje o stanie połączenia.

Nazwa	Typ	Opis
actionsRequired	string	Wymagane akcje (jeśli istnieją).
description	string	Opis stanu połączenia.
status	PersistedConnectionStatus	Stan połączenia.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DataResidencyBoundary

Data Residency granicę zasobu.

Nazwa	Typ	Opis
WithinGeopair	string
WithinRegion	string

IdentityInfo

Informacje o tożsamości zasobu.

Nazwa	Typ	Opis
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości zasobu.
tenantId	string	Identyfikator dzierżawy zasobu.
type	IdentityType	Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie dowolnej tożsamości.
userAssignedIdentities	<string,  UserIdentityProperties>	Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Ta właściwość nie jest obecnie używana i zarezerwowana do użycia w przyszłości.

IdentityType

Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie dowolnej tożsamości.

Nazwa	Typ	Opis
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

InboundIpRule

Nazwa	Typ	Opis
action	IpActionType	Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask.
ipMask	string	Adres IP w notacji CIDR, np. 10.0.0.0/8.

InputSchema

Określa to format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących publikowanych w zasobie domeny usługi Event Grid.

Nazwa	Typ	Opis
CloudEventSchemaV1_0	string
CustomEventSchema	string
EventGridSchema	string

IpActionType

Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask.

Nazwa	Typ	Opis
Allow	string

JsonField

Służy to do wyrażania źródła mapowania schematu wejściowego dla pojedynczego pola docelowego w schemacie zdarzeń usługi Event Grid. Jest to obecnie używane w mapowaniach właściwości "id", "topic" i "eventtime". Reprezentuje to pole w schemacie zdarzeń wejściowych.

Nazwa	Typ	Opis
sourceField	string	Nazwa pola w schemacie zdarzeń wejściowych, które mają być używane jako źródło mapowania.

JsonFieldWithDefault

Służy to do wyrażania źródła mapowania schematu wejściowego dla pojedynczego pola docelowego w schemacie zdarzeń usługi Event Grid. Jest to obecnie używane w mapowaniach właściwości "subject", "eventtype" i "dataversion". Reprezentuje to pole w schemacie zdarzeń wejściowych wraz z wartością domyślną, która ma być używana, i należy podać co najmniej jedną z tych dwóch właściwości.

Nazwa	Typ	Opis
defaultValue	string	Wartość domyślna, która ma być używana do mapowania, gdy pole źródłowe nie jest podane lub jeśli nie ma właściwości o określonej nazwie w opublikowanym ładunku zdarzenia JSON.
sourceField	string	Nazwa pola w schemacie zdarzeń wejściowych, które mają być używane jako źródło mapowania.

JsonInputSchemaMapping

Umożliwia to publikowanie w usłudze Event Grid przy użyciu niestandardowego schematu wejściowego. Może to służyć do mapowania właściwości z niestandardowego schematu wejściowego JSON na schemat zdarzeń usługi Event Grid.

Nazwa	Typ	Opis
inputSchemaMappingType	string: Json	Typ mapowania niestandardowego
properties.dataVersion	JsonFieldWithDefault	Informacje o mapowaniu właściwości DataVersion zdarzenia usługi Event Grid.
properties.eventTime	JsonField	Informacje o mapowaniu właściwości EventTime zdarzenia usługi Event Grid.
properties.eventType	JsonFieldWithDefault	Informacje o mapowaniu właściwości EventType zdarzenia usługi Event Grid.
properties.id	JsonField	Informacje o mapowaniu właściwości Id zdarzenia usługi Event Grid.
properties.subject	JsonFieldWithDefault	Informacje o mapowaniu właściwości Subject zdarzenia usługi Event Grid.
properties.topic	JsonField	Informacje o mapowaniu właściwości Topic zdarzenia usługi Event Grid.

PersistedConnectionStatus

Stan połączenia.

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

Informacje dotyczące prywatnego punktu końcowego.

Nazwa	Typ	Opis
id	string	Identyfikator usługi ARM dla prywatnego punktu końcowego.

PrivateEndpointConnection

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu.
name	string	Nazwa zasobu.
properties.groupIds	string[]	GroupIds z zasobu usługi łącza prywatnego.
properties.privateEndpoint	PrivateEndpoint	Zasób prywatnego punktu końcowego dla tego połączenia.
properties.privateLinkServiceConnectionState	ConnectionState	Szczegółowe informacje o stanie połączenia.
properties.provisioningState	ResourceProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
type	string	Typ zasobu.

PublicNetworkAccess

Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest ona włączona. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując

Nazwa	Typ	Opis
Disabled	string
Enabled	string

ResourceProvisioningState

Stan aprowizacji połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Topic

EventGrid — temat

Nazwa	Typ	Wartość domyślna	Opis
id	string		W pełni kwalifikowany identyfikator zasobu.
identity	IdentityInfo		Informacje o tożsamości zasobu.
location	string		Lokalizacja zasobu.
name	string		Nazwa zasobu.
properties.dataResidencyBoundary	DataResidencyBoundary		Data Residency granicę zasobu.
properties.disableLocalAuth	boolean	False	Ta wartość logiczna służy do włączania lub wyłączania uwierzytelniania lokalnego. Wartość domyślna to false. Jeśli właściwość jest ustawiona na wartość true, tylko token usługi AAD będzie używany do uwierzytelniania, jeśli użytkownik może publikować w temacie.
properties.endpoint	string		Punkt końcowy tematu.
properties.inboundIpRules	InboundIpRule[]		Może to służyć do ograniczania ruchu z określonych adresów IP zamiast wszystkich adresów IP. Uwaga: są one brane pod uwagę tylko wtedy, gdy funkcja PublicNetworkAccess jest włączona.
properties.inputSchema	InputSchema	EventGridSchema	Określa format, którego usługa Event Grid powinna oczekiwać dla zdarzeń przychodzących opublikowanych w temacie.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Umożliwia to publikowanie przy użyciu niestandardowych schematów zdarzeń. Można określić element InputSchemaMapping w celu mapowania różnych właściwości schematu źródłowego na różne wymagane właściwości schematu EventGridEvent.
properties.metricResourceId	string		Identyfikator zasobu metryki dla tematu.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	TopicProvisioningState		Stan aprowizacji tematu.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest ona włączona. Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując
systemData	systemData		Metadane systemowe odnoszące się do zasobu tematu.
tags	object		Tagi zasobu.
type	string		Typ zasobu.

TopicProvisioningState

Stan aprowizacji tematu.

Nazwa	Typ	Opis
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

UserIdentityProperties

Informacje o tożsamości użytkownika.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta tożsamości przypisanej przez użytkownika.
principalId	string	Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika.