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	リソースを作成した ID の種類。
DataResidencyBoundary	リソースのデータ所在地の境界。
IdentityInfo	リソースの ID 情報。
IdentityType	使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。
InboundIpRule
InputSchema	これにより、Event Grid ドメイン リソースに発行された受信イベントに対して Event Grid で想定される形式が決まります。
IpActionType	IpMask の一致または一致に基づいて実行するアクション。
JsonField	これは、Event Grid イベント スキーマ内の 1 つのターゲット フィールドの入力スキーマ マッピングのソースを表すために使用されます。 これは現在、'id'、'topic'、および 'eventtime' プロパティのマッピングで使用されています。 これは、入力イベント スキーマのフィールドを表します。
JsonFieldWithDefault	これは、Event Grid イベント スキーマ内の 1 つのターゲット フィールドの入力スキーマ マッピングのソースを表すために使用されます。 これは現在、'subject'、'eventtype'、および 'dataversion' プロパティのマッピングで使用されています。 これは、入力イベント スキーマ内のフィールドと使用する既定値を表し、これら 2 つのプロパティのうち少なくとも 1 つを指定する必要があります。
JsonInputSchemaMapping	これにより、カスタム入力スキーマを使用して Event Grid に発行できます。 これを使用して、カスタム入力 JSON スキーマのプロパティを Event Grid イベント スキーマにマップできます。
PersistedConnectionStatus	接続の状態。
PrivateEndpoint	PrivateEndpoint 情報。
PrivateEndpointConnection
PublicNetworkAccess	これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 を構成することで、特定の IP にさらに制限できます。
ResourceProvisioningState	プライベート エンドポイント接続のプロビジョニング状態。
systemData	リソースの作成と最後の変更に関連するメタデータ。
Topic	EventGrid トピック
TopicProvisioningState	トピックのプロビジョニング状態。
UserIdentityProperties	ユーザー ID に関する情報。

ConnectionState

Object

ConnectionState 情報。

名前	型	説明
actionsRequired	string	必要なアクション (ある場合)。
description	string	接続状態の説明。
status	PersistedConnectionStatus	接続の状態。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

DataResidencyBoundary

列挙

リソースのデータ所在地の境界。

値	説明
WithinGeopair
WithinRegion

IdentityInfo

Object

リソースの ID 情報。

名前	型	説明
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 が削除されます。

値	説明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

InboundIpRule

Object

名前	型	説明
action	IpActionType	IpMask の一致または一致に基づいて実行するアクション。
ipMask	string	CIDR 表記の IP アドレス (例: 10.0.0.0/8)。

InputSchema

列挙

これにより、Event Grid ドメイン リソースに発行された受信イベントに対して Event Grid で想定される形式が決まります。

値	説明
CloudEventSchemaV1_0
CustomEventSchema
EventGridSchema

IpActionType

列挙

IpMask の一致または一致に基づいて実行するアクション。

値	説明
Allow

JsonField

Object

これは、Event Grid イベント スキーマ内の 1 つのターゲット フィールドの入力スキーマ マッピングのソースを表すために使用されます。 これは現在、'id'、'topic'、および 'eventtime' プロパティのマッピングで使用されています。 これは、入力イベント スキーマのフィールドを表します。

名前	型	説明
sourceField	string	マッピングのソースとして使用される入力イベント スキーマ内のフィールドの名前。

JsonFieldWithDefault

Object

これは、Event Grid イベント スキーマ内の 1 つのターゲット フィールドの入力スキーマ マッピングのソースを表すために使用されます。 これは現在、'subject'、'eventtype'、および 'dataversion' プロパティのマッピングで使用されています。 これは、入力イベント スキーマ内のフィールドと使用する既定値を表し、これら 2 つのプロパティのうち少なくとも 1 つを指定する必要があります。

名前	型	説明
defaultValue	string	SourceField が指定されていない場合、または発行された JSON イベント ペイロードに指定された名前のプロパティがない場合に、マッピングに使用される既定値。
sourceField	string	マッピングのソースとして使用される入力イベント スキーマ内のフィールドの名前。

JsonInputSchemaMapping

Object

これにより、カスタム入力スキーマを使用して Event Grid に発行できます。 これを使用して、カスタム入力 JSON スキーマのプロパティを Event Grid イベント スキーマにマップできます。

名前	型	説明
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

列挙

接続の状態。

値	説明
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Object

PrivateEndpoint 情報。

名前	型	説明
id	string	プライベート エンドポイントの ARM 識別子。

PrivateEndpointConnection

Object

名前	型	説明
id	string	リソースの完全修飾識別子。
name	string	リソースの名前。
properties.groupIds	string[]	プライベート リンク サービス リソースの GroupId。
properties.privateEndpoint	PrivateEndpoint	この接続のプライベート エンドポイント リソース。
properties.privateLinkServiceConnectionState	ConnectionState	接続の状態に関する詳細。
properties.provisioningState	ResourceProvisioningState	プライベート エンドポイント接続のプロビジョニング状態。
type	string	リソースの種類。

PublicNetworkAccess

列挙

これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 を構成することで、特定の IP にさらに制限できます。

値	説明
Disabled
Enabled

ResourceProvisioningState

列挙

プライベート エンドポイント接続のプロビジョニング状態。

値	説明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

Topic

Object

EventGrid トピック

名前	型	規定値	説明
id	string		リソースの完全修飾識別子。
identity	IdentityInfo		リソースの ID 情報。
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	これにより、トピックに発行された受信イベントに対して Event Grid で想定される形式が決まります。
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
Creating
Deleting
Failed
Succeeded
Updating

UserIdentityProperties

Object

ユーザー ID に関する情報。

名前	型	説明
clientId	string	ユーザー割り当て ID のクライアント ID。
principalId	string	ユーザー割り当て ID のプリンシパル ID。