Topics - Get

Service:

Event Grid

API Version:

2022-06-15

토픽을 가져옵니다.
토픽의 속성을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	사용자의 구독 내에 있는 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
topicName	path	True	string	항목의 이름입니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다.

응답

Name	형식	Description
200 OK	Topic	정상
Other Status Codes		오류 응답: *** 400 잘못된 요청. 500 내부 서버 오류.

예제

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

정의

Name	Description
ConnectionState	ConnectionState 정보입니다.
createdByType	리소스를 만든 ID 유형입니다.
DataResidencyBoundary	리소스의 Data Residency 경계입니다.
IdentityInfo	리소스의 ID 정보입니다.
IdentityType	사용되는 관리 ID의 유형입니다. 'SystemAssigned, UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 ID를 제거합니다.
InboundIpRule
InputSchema	이는 Event Grid 도메인 리소스에 게시된 들어오는 이벤트에 대해 Event Grid가 예상해야 하는 형식을 결정합니다.
IpActionType	IpMask의 일치 또는 일치 항목에 따라 수행할 작업입니다.
JsonField	Event Grid 이벤트 스키마에서 단일 대상 필드에 대한 입력 스키마 매핑의 원본을 표현하는 데 사용됩니다. 현재 'id', 'topic' 및 'eventtime' 속성에 대한 매핑에 사용됩니다. 입력 이벤트 스키마의 필드를 나타냅니다.
JsonFieldWithDefault	Event Grid 이벤트 스키마에서 단일 대상 필드에 대한 입력 스키마 매핑의 원본을 표현하는 데 사용됩니다. 이는 현재 'subject', 'eventtype' 및 'dataversion' 속성에 대한 매핑에 사용됩니다. 이는 사용할 기본값과 함께 입력 이벤트 스키마의 필드를 나타내며, 이러한 두 속성 중 하나 이상을 제공해야 합니다.
JsonInputSchemaMapping	이렇게 하면 사용자 지정 입력 스키마를 사용하여 Event Grid에 게시할 수 있습니다. 사용자 지정 입력 JSON 스키마의 속성을 Event Grid 이벤트 스키마에 매핑하는 데 사용할 수 있습니다.
PersistedConnectionStatus	연결의 상태입니다.
PrivateEndpoint	PrivateEndpoint 정보입니다.
PrivateEndpointConnection
PublicNetworkAccess	이는 공용 네트워크를 통해 트래픽이 허용되는지 여부를 결정합니다. 기본적으로 사용하도록 설정됩니다. 구성하여 특정 IP로 더 제한할 수 있습니다.
ResourceProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
Topic	EventGrid 토픽
TopicProvisioningState	토픽의 프로비전 상태입니다.
UserIdentityProperties	사용자 ID에 대한 정보입니다.

ConnectionState

ConnectionState 정보입니다.

Name	형식	Description
actionsRequired	string	작업이 필요합니다(있는 경우).
description	string	연결 상태에 대한 설명입니다.
status	PersistedConnectionStatus	연결의 상태입니다.

createdByType

리소스를 만든 ID 유형입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataResidencyBoundary

리소스의 Data Residency 경계입니다.

Name	형식	Description
WithinGeopair	string
WithinRegion	string

IdentityInfo

리소스의 ID 정보입니다.

Name	형식	Description
principalId	string	리소스 ID의 보안 주체 ID입니다.
tenantId	string	리소스의 테넌트 ID입니다.
type	IdentityType	사용되는 관리 ID의 유형입니다. 'SystemAssigned, UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 ID를 제거합니다.
userAssignedIdentities	<string,  UserIdentityProperties>	리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다. 이 속성은 현재 사용되지 않으며 향후 사용을 위해 예약되어 있습니다.

IdentityType

사용되는 관리 ID의 유형입니다. 'SystemAssigned, UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 ID를 제거합니다.

Name	형식	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

InboundIpRule

Name	형식	Description
action	IpActionType	IpMask의 일치 또는 일치 항목에 따라 수행할 작업입니다.
ipMask	string	CIDR 표기법의 IP 주소(예: 10.0.0.0/8).

InputSchema

이는 Event Grid 도메인 리소스에 게시된 들어오는 이벤트에 대해 Event Grid가 예상해야 하는 형식을 결정합니다.

Name	형식	Description
CloudEventSchemaV1_0	string
CustomEventSchema	string
EventGridSchema	string

IpActionType

IpMask의 일치 또는 일치 항목에 따라 수행할 작업입니다.

Name	형식	Description
Allow	string

JsonField

Event Grid 이벤트 스키마에서 단일 대상 필드에 대한 입력 스키마 매핑의 원본을 표현하는 데 사용됩니다. 현재 'id', 'topic' 및 'eventtime' 속성에 대한 매핑에 사용됩니다. 입력 이벤트 스키마의 필드를 나타냅니다.

Name	형식	Description
sourceField	string	매핑의 원본으로 사용할 입력 이벤트 스키마의 필드 이름입니다.

JsonFieldWithDefault

Event Grid 이벤트 스키마에서 단일 대상 필드에 대한 입력 스키마 매핑의 원본을 표현하는 데 사용됩니다. 이는 현재 'subject', 'eventtype' 및 'dataversion' 속성에 대한 매핑에 사용됩니다. 이는 사용할 기본값과 함께 입력 이벤트 스키마의 필드를 나타내며, 이러한 두 속성 중 하나 이상을 제공해야 합니다.

Name	형식	Description
defaultValue	string	SourceField가 제공되지 않거나 게시된 JSON 이벤트 페이로드에 지정된 이름의 속성이 없는 경우 매핑에 사용할 기본값입니다.
sourceField	string	매핑의 원본으로 사용할 입력 이벤트 스키마의 필드 이름입니다.

JsonInputSchemaMapping

이렇게 하면 사용자 지정 입력 스키마를 사용하여 Event Grid에 게시할 수 있습니다. 사용자 지정 입력 JSON 스키마의 속성을 Event Grid 이벤트 스키마에 매핑하는 데 사용할 수 있습니다.

Name	형식	Description
inputSchemaMappingType	string: Json	사용자 지정 매핑 유형
properties.dataVersion	JsonFieldWithDefault	Event Grid 이벤트의 DataVersion 속성에 대한 매핑 정보입니다.
properties.eventTime	JsonField	Event Grid 이벤트의 EventTime 속성에 대한 매핑 정보입니다.
properties.eventType	JsonFieldWithDefault	Event Grid 이벤트의 EventType 속성에 대한 매핑 정보입니다.
properties.id	JsonField	Event Grid 이벤트의 Id 속성에 대한 매핑 정보입니다.
properties.subject	JsonFieldWithDefault	Event Grid 이벤트의 Subject 속성에 대한 매핑 정보입니다.
properties.topic	JsonField	Event Grid 이벤트의 Topic 속성에 대한 매핑 정보입니다.

PersistedConnectionStatus

연결의 상태입니다.

Name	형식	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint 정보입니다.

Name	형식	Description
id	string	프라이빗 엔드포인트에 대한 ARM 식별자입니다.

PrivateEndpointConnection

Name	형식	Description
id	string	리소스의 정규화된 식별자입니다.
name	string	리소스의 이름입니다.
properties.groupIds	string[]	프라이빗 링크 서비스 리소스의 GroupId입니다.
properties.privateEndpoint	PrivateEndpoint	이 연결에 대한 프라이빗 엔드포인트 리소스입니다.
properties.privateLinkServiceConnectionState	ConnectionState	연결 상태에 대한 세부 정보입니다.
properties.provisioningState	ResourceProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.
type	string	리소스 유형입니다.

PublicNetworkAccess

이는 공용 네트워크를 통해 트래픽이 허용되는지 여부를 결정합니다. 기본적으로 사용하도록 설정됩니다. 구성하여 특정 IP로 더 제한할 수 있습니다.

Name	형식	Description
Disabled	string
Enabled	string

ResourceProvisioningState

프라이빗 엔드포인트 연결의 프로비전 상태입니다.

Name	형식	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID 유형입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.

Topic

EventGrid 토픽

Name	형식	기본값	Description
id	string		리소스의 정규화된 식별자입니다.
identity	IdentityInfo		리소스에 대한 ID 정보입니다.
location	string		리소스의 위치입니다.
name	string		리소스의 이름입니다.
properties.dataResidencyBoundary	DataResidencyBoundary		리소스의 Data Residency 경계입니다.
properties.disableLocalAuth	boolean	False	이 부울은 로컬 인증을 사용하거나 사용하지 않도록 설정하는 데 사용됩니다. 기본값은 false입니다. 속성이 true로 설정되면 사용자가 토픽에 게시할 수 있는 경우 AAD 토큰만 인증하는 데 사용됩니다.
properties.endpoint	string		토픽의 엔드포인트입니다.
properties.inboundIpRules	InboundIpRule[]		모든 IP 대신 특정 IP의 트래픽을 제한하는 데 사용할 수 있습니다. 참고: PublicNetworkAccess를 사용하도록 설정한 경우에만 고려됩니다.
properties.inputSchema	InputSchema	EventGridSchema	이는 Event Grid가 토픽에 게시된 들어오는 이벤트에 대해 예상해야 하는 형식을 결정합니다.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		이렇게 하면 사용자 지정 이벤트 스키마를 사용하여 게시할 수 있습니다. Source 스키마의 다양한 속성을 EventGridEvent 스키마의 다양한 필수 속성에 매핑하도록 InputSchemaMapping을 지정할 수 있습니다.
properties.metricResourceId	string		토픽의 메트릭 리소스 ID입니다.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	TopicProvisioningState		토픽의 프로비전 상태입니다.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	이는 공용 네트워크를 통해 트래픽이 허용되는지 여부를 결정합니다. 기본적으로 사용하도록 설정됩니다. 구성하여 특정 IP로 더 제한할 수 있습니다.
systemData	systemData		토픽 리소스와 관련된 시스템 메타데이터입니다.
tags	object		리소스의 태그입니다.
type	string		리소스 유형입니다.

TopicProvisioningState

토픽의 프로비전 상태입니다.

Name	형식	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

UserIdentityProperties

사용자 ID에 대한 정보입니다.

Name	형식	Description
clientId	string	사용자 할당 ID의 클라이언트 ID입니다.
principalId	string	사용자 할당 ID의 보안 주체 ID입니다.