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. Идентификатор подписки формирует часть URI для каждого вызова службы.
topicName	path	True	string	Имя раздела.
api-version	query	True	string	Версия API для использования с клиентским запросом.

Ответы

Имя	Тип	Описание
200 OK	Topic	ОК
Other Status Codes		Ответы об ошибках: *** 400 — Bad Request (недопустимый запрос). 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	Сведения о частной конечной точке.
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	Идентификатор субъекта удостоверения ресурса.
tenantId	string	Идентификатор клиента ресурса.
type	IdentityType	Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None приведет к удалению всех удостоверений.
userAssignedIdentities	<string,  UserIdentityProperties>	Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/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	IP-адрес в нотации CIDR, например 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

Сведения о частной конечной точке.

Имя	Тип	Описание
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

Имя	Тип	Default value	Описание
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		Идентификатор ресурса метрики для раздела.
properties.privateEndpointConnections	PrivateEndpointConnection[]
properties.provisioningState	TopicProvisioningState		Состояние подготовки раздела.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. Можно дополнительно ограничить определенными IP-адресами, настроив
systemData	systemData		Системные метаданные, относящиеся к ресурсу Topic.
tags	object		Теги ресурса.
type	string		Тип ресурса.

TopicProvisioningState

Состояние подготовки раздела.

Имя	Тип	Описание
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

UserIdentityProperties

Сведения об удостоверении пользователя.

Имя	Тип	Описание
clientId	string	Идентификатор клиента удостоверения, назначаемого пользователем.
principalId	string	Идентификатор субъекта удостоверения, назначаемого пользователем.