你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Topics - Get

服务:

Event Grid

API 版本:

2022-06-15

获取主题。
获取主题的属性。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	用户订阅中资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
topicName	path	True	string	主题名称。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。

响应

名称	类型	说明
200 OK	Topic	确定
Other Status Codes		错误响应：*** 400 错误请求。 500 内部服务器错误。

示例

Topics_Get

示例请求

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

示例响应

状态代码:

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

定义

名称	说明
ConnectionState	ConnectionState 信息。
createdByType	创建资源的标识类型。
DataResidencyBoundary	资源Data Residency边界。
IdentityInfo	资源的标识信息。
IdentityType	使用的托管标识的类型。 类型“SystemAssigned， UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。
InboundIpRule
InputSchema	这决定了事件网格对发布到事件网格域资源的传入事件应采用的格式。
IpActionType	要根据 IpMask 的匹配项或不匹配执行的操作。
JsonField	这用于表示事件网格事件架构中单个目标字段的输入架构映射的源。 这当前用于“id”、“topic”和“eventtime”属性的映射中。 这表示输入事件架构中的字段。
JsonFieldWithDefault	这用于表示事件网格事件架构中单个目标字段的输入架构映射的源。 这当前在“subject”、“eventtype”和“dataversion”属性的映射中使用。 这表示输入事件架构中的字段以及要使用的默认值，并且至少应提供这两个属性中的一个。
JsonInputSchemaMapping	这允许使用自定义输入架构发布到事件网格。 这可用于将属性从自定义输入 JSON 架构映射到事件网格事件架构。
PersistedConnectionStatus	连接状态。
PrivateEndpoint	PrivateEndpoint 信息。
PrivateEndpointConnection
PublicNetworkAccess	这确定是否允许通过公用网络进行流量。 默认情况下，它处于启用状态。 可以通过配置来进一步限制为特定 IP
ResourceProvisioningState	专用终结点连接的预配状态。
systemData	与资源的创建和上次修改相关的元数据。
Topic	EventGrid 主题
TopicProvisioningState	主题的预配状态。
UserIdentityProperties	有关用户标识的信息。

ConnectionState

ConnectionState 信息。

名称	类型	说明
actionsRequired	string	如果有任何) ， (所需的操作。
description	string	连接状态的说明。
status	PersistedConnectionStatus	连接状态。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DataResidencyBoundary

资源Data Residency边界。

名称	类型	说明
WithinGeopair	string
WithinRegion	string

IdentityInfo

资源的标识信息。

名称	类型	说明
principalId	string	资源标识的主体 ID。
tenantId	string	资源的租户 ID。
type	IdentityType	使用的托管标识的类型。 类型“SystemAssigned， UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。
userAssignedIdentities	<string,  UserIdentityProperties>	与资源关联的用户标识列表。 用户标识字典键引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 此属性当前未使用，保留以供将来使用。

IdentityType

使用的托管标识的类型。 类型“SystemAssigned， UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

InboundIpRule

名称	类型	说明
action	IpActionType	要根据 IpMask 的匹配项或不匹配执行的操作。
ipMask	string	采用 CIDR 表示法的 IP 地址，例如 10.0.0.0/8。

InputSchema

这决定了事件网格对发布到事件网格域资源的传入事件应采用的格式。

名称	类型	说明
CloudEventSchemaV1_0	string
CustomEventSchema	string
EventGridSchema	string

IpActionType

要根据 IpMask 的匹配项或不匹配执行的操作。

名称	类型	说明
Allow	string

JsonField

这用于表示事件网格事件架构中单个目标字段的输入架构映射的源。 这当前用于“id”、“topic”和“eventtime”属性的映射中。 这表示输入事件架构中的字段。

名称	类型	说明
sourceField	string	要用作映射源的输入事件架构中的字段的名称。

JsonFieldWithDefault

这用于表示事件网格事件架构中单个目标字段的输入架构映射的源。 这当前在“subject”、“eventtype”和“dataversion”属性的映射中使用。 这表示输入事件架构中的字段以及要使用的默认值，并且至少应提供这两个属性中的一个。

名称	类型	说明
defaultValue	string	如果未提供 SourceField，或者已发布的 JSON 事件有效负载中没有具有指定名称的属性，则用于映射的默认值。
sourceField	string	要用作映射源的输入事件架构中的字段的名称。

JsonInputSchemaMapping

这允许使用自定义输入架构发布到事件网格。 这可用于将属性从自定义输入 JSON 架构映射到事件网格事件架构。

名称	类型	说明
inputSchemaMappingType	string: Json	自定义映射的类型
properties.dataVersion	JsonFieldWithDefault	事件网格事件的 DataVersion 属性的映射信息。
properties.eventTime	JsonField	事件网格事件的 EventTime 属性的映射信息。
properties.eventType	JsonFieldWithDefault	事件网格事件的 EventType 属性的映射信息。
properties.id	JsonField	事件网格事件的 Id 属性的映射信息。
properties.subject	JsonFieldWithDefault	事件网格事件的 Subject 属性的映射信息。
properties.topic	JsonField	事件网格事件的 Topic 属性的映射信息。

PersistedConnectionStatus

连接状态。

名称	类型	说明
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint 信息。

名称	类型	说明
id	string	专用终结点的 ARM 标识符。

PrivateEndpointConnection

名称	类型	说明
id	string	资源的完全限定标识符。
name	string	资源的名称。
properties.groupIds	string[]	专用链接服务资源的 GroupIds。
properties.privateEndpoint	PrivateEndpoint	此连接的专用终结点资源。
properties.privateLinkServiceConnectionState	ConnectionState	有关连接状态的详细信息。
properties.provisioningState	ResourceProvisioningState	专用终结点连接的预配状态。
type	string	资源的类型。

PublicNetworkAccess

这确定是否允许通过公用网络进行流量。 默认情况下，它处于启用状态。 可以通过配置来进一步限制为特定 IP

名称	类型	说明
Disabled	string
Enabled	string

ResourceProvisioningState

专用终结点连接的预配状态。

名称	类型	说明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

Topic

EventGrid 主题

名称	类型	默认值	说明
id	string		资源的完全限定标识符。
identity	IdentityInfo		资源的标识信息。
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	这将确定事件网格应针对发布到主题的传入事件应采用的格式。
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		这允许使用自定义事件架构进行发布。 可以指定 InputSchemaMapping，将源架构的各种属性映射到 EventGridEvent 架构的各种必需属性。
properties.metricResourceId	string		主题的指标资源 ID。
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	TopicProvisioningState		主题的预配状态。
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	这确定是否允许通过公用网络进行流量。 默认情况下，它处于启用状态。 可以通过配置来进一步限制为特定 IP
systemData	systemData		与主题资源相关的系统元数据。
tags	object		资源的标记。
type	string		资源的类型。

TopicProvisioningState

主题的预配状态。

名称	类型	说明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

UserIdentityProperties

有关用户标识的信息。

名称	类型	说明
clientId	string	用户分配标识的客户端 ID。
principalId	string	用户分配标识的主体 ID。