Topics - Get

Referencia

Servicio:: Event Grid

Versión de la API:: 2025-02-15

Obtener un tema.
Obtiene las propiedades de un tema.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción del usuario.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
topicName	path	True	string	Nombre del tema.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	Topic	De acuerdo
Other Status Codes		Respuestas de error: *** 400 Solicitud incorrecta. Error interno del servidor 500.

Nombre

Tipo

Description

200 OK

Topic

De acuerdo

Other Status Codes

Respuestas de error: ***

400 Solicitud incorrecta.
Error interno del servidor 500.

Ejemplos

Topics_Get

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2?api-version=2025-02-15

Respuesta de muestra

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

Definiciones

Nombre	Description
ConnectionState	Información de ConnectionState.
createdByType	Tipo de identidad que creó el recurso.
DataResidencyBoundary	Límite de residencia de datos del recurso.
EventDefinitionKind	Tipo de evento usado.
EventTypeInfo	Información de tipo de evento para Canales.
IdentityInfo	Información de identidad del recurso.
IdentityType	Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad.
InboundIpRule
InlineEventProperties	Información adicional sobre cada evento insertado.
InputSchema	Esto determina el formato que Event Grid debe esperar para los eventos entrantes publicados en el recurso de dominio de Event Grid.
IpActionType	Acción que se va a realizar en función de la coincidencia o ninguna coincidencia de IpMask.
JsonField	Se usa para expresar el origen de una asignación de esquema de entrada para un único campo de destino en el esquema de eventos de Event Grid. Esto se usa actualmente en las asignaciones de las propiedades "id", "topic" y "eventtime". Esto representa un campo en el esquema de eventos de entrada.
JsonFieldWithDefault	Se usa para expresar el origen de una asignación de esquema de entrada para un único campo de destino en el esquema de eventos de Event Grid. Esto se usa actualmente en las asignaciones de las propiedades "subject", "eventtype" y "dataversion". Esto representa un campo en el esquema de eventos de entrada junto con un valor predeterminado que se va a usar y se debe proporcionar al menos una de estas dos propiedades.
JsonInputSchemaMapping	Esto permite publicar en Event Grid mediante un esquema de entrada personalizado. Esto se puede usar para asignar propiedades de un esquema JSON de entrada personalizado al esquema de eventos de Event Grid.
PersistedConnectionStatus	Estado de la conexión.
PrivateEndpoint	Información de PrivateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas configurando
ResourceProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.
systemData	Metadatos relativos a la creación y última modificación del recurso.
TlsVersion	Versión mínima de TLS del publicador que permite publicar en este dominio
Topic	Tema de EventGrid
TopicProvisioningState	Estado de aprovisionamiento del tema.
UserIdentityProperties	Información sobre la identidad del usuario.

ConnectionState

Object

Información de ConnectionState.

Nombre	Tipo	Description
actionsRequired	string	Acciones necesarias (si las hay).
description	string	Descripción del estado de conexión.
status	PersistedConnectionStatus	Estado de la conexión.

createdByType

Enumeration

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DataResidencyBoundary

Enumeration

Límite de residencia de datos del recurso.

Valor	Description
WithinGeopair
WithinRegion

EventDefinitionKind

Enumeration

Tipo de evento usado.

Valor	Description
Inline

EventTypeInfo

Object

Información de tipo de evento para Canales.

Nombre	Tipo	Description
inlineEventTypes	<string, InlineEventProperties>	Colección de tipos de eventos insertados para el recurso. Las claves de tipo de evento insertadas son de tipo cadena que representa el nombre del evento. Un ejemplo de un nombre de evento insertado válido es "Contoso.OrderCreated". Los valores de tipo de evento insertado son de tipo InlineEventProperties y contendrán información adicional para cada tipo de evento insertado.
kind	EventDefinitionKind	Tipo de evento usado.

IdentityInfo

Object

Información de identidad del recurso.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad del recurso.
tenantId	string	Identificador de inquilino del recurso.
type	IdentityType	Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad.
userAssignedIdentities	<string, UserIdentityProperties>	Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Esta propiedad no se usa actualmente y está reservada para uso futuro.

IdentityType

Enumeration

Tipo de identidad administrada usada. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará cualquier identidad.

Valor	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

InboundIpRule

Object

Nombre	Tipo	Description
action	IpActionType	Acción que se va a realizar en función de la coincidencia o ninguna coincidencia de IpMask.
ipMask	string	Dirección IP en notación CIDR, por ejemplo, 10.0.0.0/8.

InlineEventProperties

Object

Información adicional sobre cada evento insertado.

Nombre	Tipo	Description
dataSchemaUrl	string	DataSchemaUrl para el evento insertado.
description	string	Descripción del evento insertado.
displayName	string	DisplayName para el evento insertado.
documentationUrl	string	DocumentationUrl para el evento insertado.

InputSchema

Enumeration

Esto determina el formato que Event Grid debe esperar para los eventos entrantes publicados en el recurso de dominio de Event Grid.

Valor	Description
CloudEventSchemaV1_0
CustomEventSchema
EventGridSchema

IpActionType

Enumeration

Acción que se va a realizar en función de la coincidencia o ninguna coincidencia de IpMask.

Valor	Description
Allow

JsonField

Object

Se usa para expresar el origen de una asignación de esquema de entrada para un único campo de destino en el esquema de eventos de Event Grid. Esto se usa actualmente en las asignaciones de las propiedades "id", "topic" y "eventtime". Esto representa un campo en el esquema de eventos de entrada.

Nombre	Tipo	Description
sourceField	string	Nombre de un campo en el esquema de eventos de entrada que se va a usar como origen de una asignación.

JsonFieldWithDefault

Object

Se usa para expresar el origen de una asignación de esquema de entrada para un único campo de destino en el esquema de eventos de Event Grid. Esto se usa actualmente en las asignaciones de las propiedades "subject", "eventtype" y "dataversion". Esto representa un campo en el esquema de eventos de entrada junto con un valor predeterminado que se va a usar y se debe proporcionar al menos una de estas dos propiedades.

Nombre	Tipo	Description
defaultValue	string	Valor predeterminado que se va a usar para la asignación cuando no se proporciona un SourceField o si no hay ninguna propiedad con el nombre especificado en la carga del evento JSON publicado.
sourceField	string	Nombre de un campo en el esquema de eventos de entrada que se va a usar como origen de una asignación.

JsonInputSchemaMapping

Object

Esto permite publicar en Event Grid mediante un esquema de entrada personalizado. Esto se puede usar para asignar propiedades de un esquema JSON de entrada personalizado al esquema de eventos de Event Grid.

Nombre	Tipo	Description
inputSchemaMappingType	string: Json	Tipo de la asignación personalizada
properties.dataVersion	JsonFieldWithDefault	Información de asignación de la propiedad DataVersion del evento de Event Grid.
properties.eventTime	JsonField	Información de asignación de la propiedad EventTime del evento de Event Grid.
properties.eventType	JsonFieldWithDefault	Información de asignación de la propiedad EventType del evento de Event Grid.
properties.id	JsonField	Información de asignación de la propiedad Id del evento de Event Grid.
properties.subject	JsonFieldWithDefault	Información de asignación para la propiedad Subject del evento de Event Grid.
properties.topic	JsonField	Información de asignación de la propiedad Topic del evento de Event Grid.

PersistedConnectionStatus

Enumeration

Estado de la conexión.

Valor	Description
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Object

Información de PrivateEndpoint.

Nombre	Tipo	Description
id	string	Identificador de ARM para punto de conexión privado.

PrivateEndpointConnection

Object

Nombre	Tipo	Description
id	string	Identificador completo del recurso.
name	string	Nombre del recurso.
properties.groupIds	string[]	GroupIds del recurso del servicio private link.
properties.privateEndpoint	PrivateEndpoint	El recurso Punto de conexión privado para esta conexión.
properties.privateLinkServiceConnectionState	ConnectionState	Detalles sobre el estado de la conexión.
properties.provisioningState	ResourceProvisioningState	Estado de aprovisionamiento de la conexión de punto de conexión privado.
type	string	Tipo del recurso.

PublicNetworkAccess

Enumeration

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas configurando

Valor	Description
Disabled
Enabled

ResourceProvisioningState

Enumeration

Estado de aprovisionamiento de la conexión de punto de conexión privado.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TlsVersion

Enumeration

Versión mínima de TLS del publicador que permite publicar en este dominio

Valor	Description
1.0
1.1
1.2

Topic

Object

Tema de EventGrid

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador completo del recurso.
identity	IdentityInfo		Información de identidad del recurso.
location	string		Ubicación del recurso.
name	string		Nombre del recurso.
properties.dataResidencyBoundary	DataResidencyBoundary		Límite de residencia de datos del recurso.
properties.disableLocalAuth	boolean	False	Este valor booleano se usa para habilitar o deshabilitar la autenticación local. El valor predeterminado es false. Cuando la propiedad se establece en true, solo se usará el token de AAD para autenticarse si el usuario puede publicar en el tema.
properties.endpoint	string		Punto de conexión del tema.
properties.eventTypeInfo	EventTypeInfo		Información de tipo de evento para el tema de usuario. El publicador proporciona esta información y el suscriptor puede usar esta información para ver diferentes tipos de eventos publicados.
properties.inboundIpRules	InboundIpRule[]		Esto se puede usar para restringir el tráfico de direcciones IP específicas en lugar de todas las direcciones IP. Nota: Estos se consideran solo si PublicNetworkAccess está habilitado.
properties.inputSchema	InputSchema	EventGridSchema	Esto determina el formato que Event Grid debe esperar para los eventos entrantes publicados en el tema.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Esto permite la publicación mediante esquemas de eventos personalizados. Se puede especificar InputSchemaMapping para asignar varias propiedades de un esquema de origen a varias propiedades necesarias del esquema EventGridEvent.
properties.metricResourceId	string		Identificador de recurso de métrica para el tema.
properties.minimumTlsVersionAllowed	TlsVersion		Versión mínima de TLS del publicador que permite publicar en este tema
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de conexiones de punto de conexión privado.
properties.provisioningState	TopicProvisioningState		Estado de aprovisionamiento del tema.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado. Puede restringir aún más a direcciones IP específicas configurando
systemData	systemData		Metadatos del sistema relacionados con el recurso de Event Grid.
tags	object		Etiquetas del recurso.
type	string		Tipo del recurso.

TopicProvisioningState

Enumeration

Estado de aprovisionamiento del tema.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

UserIdentityProperties

Object

Información sobre la identidad del usuario.

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la identidad asignada por el usuario.
principalId	string	Identificador principal de la identidad asignada por el usuario.

Compartir a través de

Topics - Get

Parámetros de identificador URI

Respuestas

Ejemplos

Topics_Get

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ConnectionState

createdByType

DataResidencyBoundary

EventDefinitionKind

EventTypeInfo

IdentityInfo

IdentityType

InboundIpRule

InlineEventProperties

InputSchema

IpActionType

JsonField

JsonFieldWithDefault

JsonInputSchemaMapping

PersistedConnectionStatus

PrivateEndpoint

PrivateEndpointConnection

PublicNetworkAccess

ResourceProvisioningState

systemData

TlsVersion

Topic

TopicProvisioningState

UserIdentityProperties

Recursos adicionales