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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	用戶訂用帳戶內的資源組名。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
topicName	path	True	string	主題的名稱。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

回應

名稱	類型	Description
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"
}

定義

名稱	Description
ConnectionState	ConnectionState 資訊。
createdByType	建立資源的身分識別類型。
DataResidencyBoundary	資源的數據落地界限。
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

Object

ConnectionState 資訊。

名稱	類型	Description
actionsRequired	string	需要動作（如果有的話）。
description	string	連接狀態的描述。
status	PersistedConnectionStatus	線上的狀態。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

DataResidencyBoundary

列舉型別

資源的數據落地界限。

值	Description
WithinGeopair
WithinRegion

IdentityInfo

Object

資源的身分識別資訊。

名稱	類型	Description
principalId	string	資源識別的主要標識碼。
tenantId	string	資源的租用戶標識碼。
type	IdentityType	所使用的受控識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。
userAssignedIdentities	<string,  UserIdentityProperties>	與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 此屬性目前未使用，並保留供日後使用。

IdentityType

列舉型別

所使用的受控識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。

值	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

InboundIpRule

Object

名稱	類型	Description
action	IpActionType	根據相符專案或 IpMask 不相符執行的動作。
ipMask	string	CIDR 表示法中的IP位址，例如10.0.0.0.0/8。

InputSchema

列舉型別

這會決定事件方格針對發佈至事件方格網域資源之傳入事件所應預期的格式。

值	Description
CloudEventSchemaV1_0
CustomEventSchema
EventGridSchema

IpActionType

列舉型別

根據相符專案或 IpMask 不相符執行的動作。

值	Description
Allow

JsonField

Object

這是用來表示事件方格事件架構中單一目標欄位輸入架構對應的來源。 這目前用於 『id』、『topic』 和 'eventtime' 屬性的對應中。 這代表輸入事件架構中的欄位。

名稱	類型	Description
sourceField	string	輸入事件架構中要作為對應來源的功能變數名稱。

JsonFieldWithDefault

Object

這是用來表示事件方格事件架構中單一目標欄位輸入架構對應的來源。 這目前用於 'subject' 、'eventtype' 和 'dataversion' 屬性的對應中。 這代表輸入事件架構中的欄位以及要使用的預設值，而且至少應該提供這兩個屬性的其中一個。

名稱	類型	Description
defaultValue	string	未提供SourceField時要用於對應的預設值，如果已發佈的 JSON 事件承載中沒有具有指定名稱的屬性，則為 。
sourceField	string	輸入事件架構中要作為對應來源的功能變數名稱。

JsonInputSchemaMapping

Object

這可讓您使用自定義輸入架構發佈至事件方格。 這可用來將自定義輸入 JSON 架構中的屬性對應至事件方格事件架構。

名稱	類型	Description
inputSchemaMappingType	string: Json	自定義對應的類型
properties.dataVersion	JsonFieldWithDefault	事件方格事件之 DataVersion 屬性的對應資訊。
properties.eventTime	JsonField	Event Grid 事件之 EventTime 屬性的對應資訊。
properties.eventType	JsonFieldWithDefault	Event Grid 事件之 EventType 屬性的對應資訊。
properties.id	JsonField	事件方格事件的Id屬性對應資訊。
properties.subject	JsonFieldWithDefault	事件方格事件之 Subject 屬性的對應資訊。
properties.topic	JsonField	事件方格事件之 Topic 屬性的對應資訊。

PersistedConnectionStatus

列舉型別

線上的狀態。

值	Description
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Object

PrivateEndpoint 資訊。

名稱	類型	Description
id	string	私人端點的ARM標識碼。

PrivateEndpointConnection

Object

名稱	類型	Description
id	string	資源的完整標識碼。
name	string	資源的名稱。
properties.groupIds	string[]	Private Link 服務資源的 GroupId。
properties.privateEndpoint	PrivateEndpoint	此連線的私人端點資源。
properties.privateLinkServiceConnectionState	ConnectionState	線上狀態的詳細數據。
properties.provisioningState	ResourceProvisioningState	私人端點聯機的布建狀態。
type	string	資源的類型。

PublicNetworkAccess

列舉型別

這會判斷是否允許透過公用網路傳輸流量。 默認會啟用。 您可以藉由設定進一步限制特定IP

值	Description
Disabled
Enabled

ResourceProvisioningState

列舉型別

私人端點聯機的布建狀態。

值	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

Topic

Object

EventGrid 主題

名稱	類型	預設值	Description
id	string		資源的完整標識碼。
identity	IdentityInfo		資源的身分識別資訊。
location	string		資源的位置。
name	string		資源的名稱。
properties.dataResidencyBoundary	DataResidencyBoundary		資源的數據落地界限。
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		主題的計量資源標識碼。
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	TopicProvisioningState		主題的布建狀態。
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	這會判斷是否允許透過公用網路傳輸流量。 默認會啟用。 您可以藉由設定進一步限制特定IP
systemData	systemData		與主題資源相關的系統元數據。
tags	object		資源的標記。
type	string		資源的類型。

TopicProvisioningState

列舉型別

主題的布建狀態。

值	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

UserIdentityProperties

Object

使用者身分識別的相關信息。

名稱	類型	Description
clientId	string	使用者指派身分識別的用戶端標識碼。
principalId	string	使用者指派身分識別的主體標識碼。