Topics - Get

Service:

Event Grid

API Version:

2022-06-15

Bir konu alın.
Bir konunun özelliklerini alma.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kullanıcının aboneliğindeki kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
topicName	path	True	string	Konunun adı.
api-version	query	True	string	İstemci isteğiyle kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	Topic	Tamam
Other Status Codes		Hata Yanıtları: *** 400 Hatalı İstek. 500 İç Sunucu Hatası.

Örnekler

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

Tanımlar

Name	Description
ConnectionState	ConnectionState bilgileri.
createdByType	Kaynağı oluşturan kimliğin türü.
DataResidencyBoundary	kaynağın Data Residency Sınırı.
IdentityInfo	Kaynağın kimlik bilgileri.
IdentityType	Kullanılan yönetilen kimliğin türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimlik hem de kullanıcı tarafından atanan kimlikler kümesini içerir. 'Hiçbiri' türü herhangi bir kimliği kaldırır.
InboundIpRule
InputSchema	Bu, Event Grid'in Event Grid Etki Alanı Kaynağı'nda yayımlanan gelen olaylar için beklemesi gereken biçimi belirler.
IpActionType	IpMask'in eşleşmesine veya eşleşmesine bağlı olarak gerçekleştirilecek eylem.
JsonField	Bu, Event Grid Olay şemasındaki tek bir hedef alan için giriş şeması eşlemesinin kaynağını ifade etmek için kullanılır. Bu, şu anda 'id', 'topic' ve 'eventtime' özellikleri için eşlemelerde kullanılır. Bu, giriş olayı şemasındaki bir alanı temsil eder.
JsonFieldWithDefault	Bu, Event Grid Olay şemasındaki tek bir hedef alan için giriş şeması eşlemesinin kaynağını ifade etmek için kullanılır. Bu, şu anda 'subject', 'eventtype' ve 'dataversion' özellikleri için eşlemelerde kullanılır. Bu, giriş olayı şemasında kullanılacak varsayılan değerle birlikte bir alanı temsil eder ve bu iki özelliğin en az biri sağlanmalıdır.
JsonInputSchemaMapping	Bu, özel bir giriş şeması kullanarak Event Grid'de yayımlamayı sağlar. Bu, özel giriş JSON şemasındaki özellikleri Event Grid olay şemasına eşlemek için kullanılabilir.
PersistedConnectionStatus	Bağlantının durumu.
PrivateEndpoint	PrivateEndpoint bilgileri.
PrivateEndpointConnection
PublicNetworkAccess	Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Yapılandırarak belirli IP'leri daha da kısıtlayabilirsiniz
ResourceProvisioningState	Özel Uç Nokta Bağlantısının sağlama durumu.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
Topic	EventGrid Konusu
TopicProvisioningState	Konunun sağlama durumu.
UserIdentityProperties	Kullanıcı kimliği hakkındaki bilgiler.

ConnectionState

ConnectionState bilgileri.

Name	Tür	Description
actionsRequired	string	Gerekli eylemler (varsa).
description	string	Bağlantı durumunun açıklaması.
status	PersistedConnectionStatus	Bağlantının durumu.

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataResidencyBoundary

kaynağın Data Residency Sınırı.

Name	Tür	Description
WithinGeopair	string
WithinRegion	string

IdentityInfo

Kaynağın kimlik bilgileri.

Name	Tür	Description
principalId	string	Kaynak kimliğinin asıl kimliği.
tenantId	string	Kaynağın kiracı kimliği.
type	IdentityType	Kullanılan yönetilen kimliğin türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimlik hem de kullanıcı tarafından atanan kimlikler kümesini içerir. 'Hiçbiri' türü herhangi bir kimliği kaldırır.
userAssignedIdentities	<string,  UserIdentityProperties>	Kaynakla ilişkilendirilmiş kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlüğü anahtar başvuruları şu biçimde ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Bu özellik şu anda kullanılmamış ve gelecekte kullanılmak üzere ayrılmıştır.

IdentityType

Kullanılan yönetilen kimliğin türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimlik hem de kullanıcı tarafından atanan kimlikler kümesini içerir. 'Hiçbiri' türü herhangi bir kimliği kaldırır.

Name	Tür	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

InboundIpRule

Name	Tür	Description
action	IpActionType	IpMask'in eşleşmesine veya eşleşmesine bağlı olarak gerçekleştirilecek eylem.
ipMask	string	CIDR gösteriminde IP Adresi; örneğin, 10.0.0.0/8.

InputSchema

Bu, Event Grid'in Event Grid Etki Alanı Kaynağı'nda yayımlanan gelen olaylar için beklemesi gereken biçimi belirler.

Name	Tür	Description
CloudEventSchemaV1_0	string
CustomEventSchema	string
EventGridSchema	string

IpActionType

IpMask'in eşleşmesine veya eşleşmesine bağlı olarak gerçekleştirilecek eylem.

Name	Tür	Description
Allow	string

JsonField

Bu, Event Grid Olay şemasındaki tek bir hedef alan için giriş şeması eşlemesinin kaynağını ifade etmek için kullanılır. Bu, şu anda 'id', 'topic' ve 'eventtime' özellikleri için eşlemelerde kullanılır. Bu, giriş olayı şemasındaki bir alanı temsil eder.

Name	Tür	Description
sourceField	string	Eşlemenin kaynağı olarak kullanılacak giriş olayı şemasındaki bir alanın adı.

JsonFieldWithDefault

Bu, Event Grid Olay şemasındaki tek bir hedef alan için giriş şeması eşlemesinin kaynağını ifade etmek için kullanılır. Bu, şu anda 'subject', 'eventtype' ve 'dataversion' özellikleri için eşlemelerde kullanılır. Bu, giriş olayı şemasında kullanılacak varsayılan değerle birlikte bir alanı temsil eder ve bu iki özelliğin en az biri sağlanmalıdır.

Name	Tür	Description
defaultValue	string	SourceField sağlanmadığında veya yayımlanan JSON olay yükünde belirtilen ada sahip bir özellik yoksa eşleme için kullanılacak varsayılan değer.
sourceField	string	Eşlemenin kaynağı olarak kullanılacak giriş olayı şemasındaki bir alanın adı.

JsonInputSchemaMapping

Bu, özel bir giriş şeması kullanarak Event Grid'de yayımlamayı sağlar. Bu, özel giriş JSON şemasındaki özellikleri Event Grid olay şemasına eşlemek için kullanılabilir.

Name	Tür	Description
inputSchemaMappingType	string: Json	Özel eşlemenin türü
properties.dataVersion	JsonFieldWithDefault	Event Grid Olayının DataVersion özelliği için eşleme bilgileri.
properties.eventTime	JsonField	Event Grid Olayının EventTime özelliği için eşleme bilgileri.
properties.eventType	JsonFieldWithDefault	Event Grid Olayının EventType özelliği için eşleme bilgileri.
properties.id	JsonField	Event Grid Olayının Id özelliği için eşleme bilgileri.
properties.subject	JsonFieldWithDefault	Event Grid Olayının Subject özelliği için eşleme bilgileri.
properties.topic	JsonField	Event Grid Olayının Topic özelliği için eşleme bilgileri.

PersistedConnectionStatus

Bağlantının durumu.

Name	Tür	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint bilgileri.

Name	Tür	Description
id	string	Özel Uç Nokta için ARM tanımlayıcısı.

PrivateEndpointConnection

Name	Tür	Description
id	string	Kaynağın tam tanımlayıcısı.
name	string	Kaynağın adı.
properties.groupIds	string[]	Özel bağlantı hizmeti kaynağındaki GroupId'ler.
properties.privateEndpoint	PrivateEndpoint	Bu Bağlantı için Özel Uç Nokta kaynağı.
properties.privateLinkServiceConnectionState	ConnectionState	Bağlantının durumuyla ilgili ayrıntılar.
properties.provisioningState	ResourceProvisioningState	Özel Uç Nokta Bağlantısının sağlama durumu.
type	string	Kaynağın türü.

PublicNetworkAccess

Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Yapılandırarak belirli IP'leri daha da kısıtlayabilirsiniz

Name	Tür	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Özel Uç Nokta Bağlantısının sağlama durumu.

Name	Tür	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

Topic

EventGrid Konusu

Name	Tür	Varsayılan değer	Description
id	string		Kaynağın tam tanımlayıcısı.
identity	IdentityInfo		Kaynak için kimlik bilgileri.
location	string		Kaynağın konumu.
name	string		Kaynağın adı.
properties.dataResidencyBoundary	DataResidencyBoundary		kaynağın Data Residency Sınırı.
properties.disableLocalAuth	boolean	False	Bu boole yerel kimlik doğrulamasını etkinleştirmek veya devre dışı bırakmak için kullanılır. Varsayılan değer false'tur. Özellik true olarak ayarlandığında, kullanıcının konuya yayımlamasına izin verilirse kimlik doğrulaması için yalnızca AAD belirteci kullanılır.
properties.endpoint	string		Konu için uç nokta.
properties.inboundIpRules	InboundIpRule[]		Bu, tüm IP'ler yerine belirli IP'lerden gelen trafiği kısıtlamak için kullanılabilir. Not: Bunlar yalnızca PublicNetworkAccess etkinleştirildiğinde dikkate alınır.
properties.inputSchema	InputSchema	EventGridSchema	Bu, Konu başlığında yayımlanan gelen olaylar için Event Grid'in beklemesi gereken biçimi belirler.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Bu, özel olay şemaları kullanarak yayımlamayı etkinleştirir. Bir kaynak şemanın çeşitli özelliklerini EventGridEvent şemasının çeşitli gerekli özellikleriyle eşlemek için bir InputSchemaMapping belirtilebilir.
properties.metricResourceId	string		Konu başlığı için ölçüm kaynak kimliği.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	TopicProvisioningState		Konunun sağlama durumu.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Yapılandırarak belirli IP'leri daha da kısıtlayabilirsiniz
systemData	systemData		Konu kaynağıyla ilgili sistem meta verileri.
tags	object		Kaynağın etiketleri.
type	string		Kaynağın türü.

TopicProvisioningState

Konunun sağlama durumu.

Name	Tür	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

UserIdentityProperties

Kullanıcı kimliği hakkındaki bilgiler.

Name	Tür	Description
clientId	string	Kullanıcı tarafından atanan kimliğin istemci kimliği.
principalId	string	Kullanıcı tarafından atanan kimliğin asıl kimliği.