Topics - Get

Obtenga un tema.
Obtiene las propiedades de un tema.

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

Parámetros de identificador URI

Name In Required Type 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 para cada llamada al 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

Name Type Description
200 OK

Aceptar

Other Status Codes

Respuestas de error: ***

  • 400 Solicitud incorrecta.

  • 500 Internal Server Error.

Ejemplos

Topics_Get

Sample Request

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

Sample Response

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

ConnectionState

Información de ConnectionState.

createdByType

Tipo de identidad que creó el recurso.

DataResidencyBoundary

Data Residency Límite del recurso.

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
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". 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". 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. 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 mediante la configuración

ResourceProvisioningState

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

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Topic

Tema de EventGrid

TopicProvisioningState

Estado de aprovisionamiento del tema.

UserIdentityProperties

Información sobre la identidad del usuario.

ConnectionState

Información de ConnectionState.

Name Type Description
actionsRequired
  • string

Acciones necesarias (si las hay).

description
  • string

Descripción del estado de conexión.

status

Estado de la conexión.

createdByType

Tipo de identidad que creó el recurso.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DataResidencyBoundary

Data Residency Límite del recurso.

Name Type Description
WithinGeopair
  • string
WithinRegion
  • string

IdentityInfo

Información de identidad del recurso.

Name Type Description
principalId
  • string

Identificador de entidad de seguridad de la identidad de recurso.

tenantId
  • string

Identificador de inquilino del recurso.

type

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

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

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.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

InboundIpRule

Name Type Description
action

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.

InputSchema

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

Name Type Description
CloudEventSchemaV1_0
  • string
CustomEventSchema
  • string
EventGridSchema
  • string

IpActionType

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

Name Type Description
Allow
  • string

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". Representa un campo en el esquema de eventos de entrada.

Name Type 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

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

Name Type 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

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

Name Type Description
inputSchemaMappingType string:
  • Json

Tipo de la asignación personalizada

properties.dataVersion

Información de asignación de la propiedad DataVersion del evento de Event Grid.

properties.eventTime

Información de asignación de la propiedad EventTime del evento de Event Grid.

properties.eventType

Información de asignación de la propiedad EventType del evento de Event Grid.

properties.id

Información de asignación de la propiedad Id del evento de Event Grid.

properties.subject

Información de asignación para la propiedad Subject del evento de Event Grid.

properties.topic

Información de asignación de la propiedad Topic del evento de Event Grid.

PersistedConnectionStatus

Estado de la conexión.

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

PrivateEndpoint

Información de PrivateEndpoint.

Name Type Description
id
  • string

Identificador de ARM para punto de conexión privado.

PrivateEndpointConnection

Name Type Description
id
  • string

Identificador completo del recurso.

name
  • string

Nombre del recurso.

properties.groupIds
  • string[]

GroupIds del recurso del servicio Private Link.

properties.privateEndpoint

Recurso de punto de conexión privado para esta conexión.

properties.privateLinkServiceConnectionState

Detalles sobre el estado de la conexión.

properties.provisioningState

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

type
  • string

Tipo de recurso.

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 mediante la configuración

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceProvisioningState

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

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Name Type Description
createdAt
  • string

Marca de tiempo de creación de recursos (UTC).

createdBy
  • string

Identidad que creó el recurso.

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

Tipo de identidad que modificó por última vez el recurso.

Topic

Tema de EventGrid

Name Type Default Value Description
id
  • string

Identificador completo del recurso.

identity

Información de identidad del recurso.

location
  • string

Ubicación del recurso.

name
  • string

Nombre del recurso.

properties.dataResidencyBoundary

Data Residency Límite 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 para el tema.

properties.inboundIpRules

Esto se puede usar para restringir el tráfico de direcciones IP específicas en lugar de todas las direcciones IP. Nota: Solo se consideran si PublicNetworkAccess está habilitado.

properties.inputSchema EventGridSchema

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

properties.inputSchemaMapping InputSchemaMapping:

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.privateEndpointConnections
properties.provisioningState

Estado de aprovisionamiento del tema.

properties.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 mediante la configuración

systemData

Metadatos del sistema relacionados con el recurso Topic.

tags
  • object

Etiquetas del recurso.

type
  • string

Tipo de recurso.

TopicProvisioningState

Estado de aprovisionamiento del tema.

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

UserIdentityProperties

Información sobre la identidad del usuario.

Name Type Description
clientId
  • string

Identificador de cliente de la identidad asignada por el usuario.

principalId
  • string

Identificador principal de la identidad asignada por el usuario.