Topics - Get

Referência

Serviço:: Event Grid

Versão da API:: 2025-02-15

Obtenha um tópico.
Obter propriedades de um tópico.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura do usuário.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
topicName	path	True	string	Nome do tópico.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Respostas

Nome	Tipo	Description
200 OK	Topic	OKEY
Other Status Codes		Respostas de erro: *** 400 Solicitação Incorreta. 500 Erro interno do servidor.

Nome

Tipo

Description

200 OK

Topic

OKEY

Other Status Codes

Respostas de erro: ***

400 Solicitação Incorreta.
500 Erro interno do servidor.

Exemplos

Topics_Get

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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"
}

Definições

Nome	Description
ConnectionState	Informações do ConnectionState.
createdByType	O tipo de identidade que criou o recurso.
DataResidencyBoundary	Limite de residência de dados do recurso.
EventDefinitionKind	O tipo de evento usado.
EventTypeInfo	As informações de tipo de evento para Canais.
IdentityInfo	As informações de identidade do recurso.
IdentityType	O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade.
InboundIpRule
InlineEventProperties	Informações adicionais sobre cada evento embutido.
InputSchema	Isso determina o formato que a Grade de Eventos deve esperar para eventos de entrada publicados no Recurso de Domínio da Grade de Eventos.
IpActionType	Ação a ser executada com base na correspondência ou nenhuma correspondência do IpMask.
JsonField	Isso é usado para expressar a origem de um mapeamento de esquema de entrada para um único campo de destino no esquema evento da Grade de Eventos. No momento, isso é usado nos mapeamentos para as propriedades 'id', 'topic' e 'eventtime'. Isso representa um campo no esquema de evento de entrada.
JsonFieldWithDefault	Isso é usado para expressar a origem de um mapeamento de esquema de entrada para um único campo de destino no esquema evento da Grade de Eventos. Atualmente, isso é usado nos mapeamentos para as propriedades 'subject', 'eventtype' e 'dataversion'. Isso representa um campo no esquema de evento de entrada, juntamente com um valor padrão a ser usado, e pelo menos uma dessas duas propriedades deve ser fornecida.
JsonInputSchemaMapping	Isso permite a publicação na Grade de Eventos usando um esquema de entrada personalizado. Isso pode ser usado para mapear propriedades de um esquema JSON de entrada personalizado para o esquema de eventos da Grade de Eventos.
PersistedConnectionStatus	Status da conexão.
PrivateEndpoint	Informações do PrivateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando
ResourceProvisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.
systemData	Metadados relativos à criação e última modificação do recurso.
TlsVersion	Versão mínima do TLS do publicador com permissão para publicar neste domínio
Topic	Tópico eventGrid
TopicProvisioningState	Estado de provisionamento do tópico.
UserIdentityProperties	As informações sobre a identidade do usuário.

ConnectionState

Object

Informações do ConnectionState.

Nome	Tipo	Description
actionsRequired	string	Ações necessárias (se houver).
description	string	Descrição do estado da conexão.
status	PersistedConnectionStatus	Status da conexão.

createdByType

Enumeration

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DataResidencyBoundary

Enumeration

Limite de residência de dados do recurso.

Valor	Description
WithinGeopair
WithinRegion

EventDefinitionKind

Enumeration

O tipo de evento usado.

Valor	Description
Inline

EventTypeInfo

Object

As informações de tipo de evento para Canais.

Nome	Tipo	Description
inlineEventTypes	<string, InlineEventProperties>	Uma coleção de tipos de eventos embutidos para o recurso. As chaves de tipo de evento embutidas são de cadeia de caracteres de tipo que representa o nome do evento. Um exemplo de um nome de evento embutido válido é "Contoso.OrderCreated". Os valores de tipo de evento embutido são do tipo InlineEventProperties e conterão informações adicionais para cada tipo de evento embutido.
kind	EventDefinitionKind	O tipo de evento usado.

IdentityInfo

Object

As informações de identidade do recurso.

Nome	Tipo	Description
principalId	string	A ID principal da identidade do recurso.
tenantId	string	A ID do locatário do recurso.
type	IdentityType	O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade.
userAssignedIdentities	<string, UserIdentityProperties>	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. No momento, essa propriedade não é usada e reservada para uso futuro.

IdentityType

Enumeration

O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade.

Valor	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

InboundIpRule

Object

Nome	Tipo	Description
action	IpActionType	Ação a ser executada com base na correspondência ou nenhuma correspondência do IpMask.
ipMask	string	Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8.

InlineEventProperties

Object

Informações adicionais sobre cada evento embutido.

Nome	Tipo	Description
dataSchemaUrl	string	O dataSchemaUrl para o evento embutido.
description	string	A descrição do evento embutido.
displayName	string	O displayName para o evento embutido.
documentationUrl	string	A documentaçãoUrl para o evento embutido.

InputSchema

Enumeration

Isso determina o formato que a Grade de Eventos deve esperar para eventos de entrada publicados no Recurso de Domínio da Grade de Eventos.

Valor	Description
CloudEventSchemaV1_0
CustomEventSchema
EventGridSchema

IpActionType

Enumeration

Ação a ser executada com base na correspondência ou nenhuma correspondência do IpMask.

Valor	Description
Allow

JsonField

Object

Isso é usado para expressar a origem de um mapeamento de esquema de entrada para um único campo de destino no esquema evento da Grade de Eventos. No momento, isso é usado nos mapeamentos para as propriedades 'id', 'topic' e 'eventtime'. Isso representa um campo no esquema de evento de entrada.

Nome	Tipo	Description
sourceField	string	Nome de um campo no esquema de evento de entrada que deve ser usado como a origem de um mapeamento.

JsonFieldWithDefault

Object

Isso é usado para expressar a origem de um mapeamento de esquema de entrada para um único campo de destino no esquema evento da Grade de Eventos. Atualmente, isso é usado nos mapeamentos para as propriedades 'subject', 'eventtype' e 'dataversion'. Isso representa um campo no esquema de evento de entrada, juntamente com um valor padrão a ser usado, e pelo menos uma dessas duas propriedades deve ser fornecida.

Nome	Tipo	Description
defaultValue	string	O valor padrão a ser usado para mapeamento quando um SourceField não é fornecido ou se não há nenhuma propriedade com o nome especificado no conteúdo do evento JSON publicado.
sourceField	string	Nome de um campo no esquema de evento de entrada que deve ser usado como a origem de um mapeamento.

JsonInputSchemaMapping

Object

Isso permite a publicação na Grade de Eventos usando um esquema de entrada personalizado. Isso pode ser usado para mapear propriedades de um esquema JSON de entrada personalizado para o esquema de eventos da Grade de Eventos.

Nome	Tipo	Description
inputSchemaMappingType	string: Json	Tipo do mapeamento personalizado
properties.dataVersion	JsonFieldWithDefault	As informações de mapeamento da propriedade DataVersion do Evento da Grade de Eventos.
properties.eventTime	JsonField	As informações de mapeamento para a propriedade EventTime do Evento da Grade de Eventos.
properties.eventType	JsonFieldWithDefault	As informações de mapeamento da propriedade EventType do Evento da Grade de Eventos.
properties.id	JsonField	As informações de mapeamento para a propriedade ID do Evento da Grade de Eventos.
properties.subject	JsonFieldWithDefault	As informações de mapeamento da propriedade Subject do Evento da Grade de Eventos.
properties.topic	JsonField	As informações de mapeamento da propriedade Topic do Evento da Grade de Eventos.

PersistedConnectionStatus

Enumeration

Status da conexão.

Valor	Description
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Object

Informações do PrivateEndpoint.

Nome	Tipo	Description
id	string	O identificador do ARM para o ponto de extremidade privado.

PrivateEndpointConnection

Object

Nome	Tipo	Description
id	string	Identificador totalmente qualificado do recurso.
name	string	Nome do recurso.
properties.groupIds	string[]	GroupIds do recurso de serviço de link privado.
properties.privateEndpoint	PrivateEndpoint	O recurso de ponto de extremidade privado para esta conexão.
properties.privateLinkServiceConnectionState	ConnectionState	Detalhes sobre o estado da conexão.
properties.provisioningState	ResourceProvisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.
type	string	Tipo do recurso.

PublicNetworkAccess

Enumeration

Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando

Valor	Description
Disabled
Enabled

ResourceProvisioningState

Enumeration

Estado de provisionamento da Conexão de Ponto de Extremidade Privado.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Object

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TlsVersion

Enumeration

Versão mínima do TLS do publicador com permissão para publicar neste domínio

Valor	Description
1.0
1.1
1.2

Topic

Object

Tópico eventGrid

Nome	Tipo	Valor padrão	Description
id	string		Identificador totalmente qualificado do recurso.
identity	IdentityInfo		Informações de identidade para o recurso.
location	string		Local do recurso.
name	string		Nome do recurso.
properties.dataResidencyBoundary	DataResidencyBoundary		Limite de residência de dados do recurso.
properties.disableLocalAuth	boolean	False	Esse booliano é usado para habilitar ou desabilitar a autenticação local. O valor padrão é falso. Quando a propriedade for definida como true, somente o token do AAD será usado para autenticar se o usuário tiver permissão para publicar no tópico.
properties.endpoint	string		Ponto de extremidade para o tópico.
properties.eventTypeInfo	EventTypeInfo		Informações de tipo de evento para o tópico do usuário. Essas informações são fornecidas pelo editor e podem ser usadas pelo assinante para exibir diferentes tipos de eventos publicados.
properties.inboundIpRules	InboundIpRule[]		Isso pode ser usado para restringir o tráfego de IPs específicos em vez de todos os IPs. Observação: elas serão consideradas somente se PublicNetworkAccess estiver habilitado.
properties.inputSchema	InputSchema	EventGridSchema	Isso determina o formato que a Grade de Eventos deve esperar para eventos de entrada publicados no tópico.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Isso permite a publicação usando esquemas de eventos personalizados. Um InputSchemaMapping pode ser especificado para mapear várias propriedades de um esquema de origem para várias propriedades necessárias do esquema EventGridEvent.
properties.metricResourceId	string		ID do recurso de métrica para o tópico.
properties.minimumTlsVersionAllowed	TlsVersion		Versão mínima do TLS do publicador autorizada a publicar neste tópico
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de conexões de ponto de extremidade privado.
properties.provisioningState	TopicProvisioningState		Estado de provisionamento do tópico.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando
systemData	systemData		Os metadados do sistema relacionados ao recurso da Grade de Eventos.
tags	object		Marcas do recurso.
type	string		Tipo do recurso.

TopicProvisioningState

Enumeration

Estado de provisionamento do tópico.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

UserIdentityProperties

Object

As informações sobre a identidade do usuário.

Nome	Tipo	Description
clientId	string	A ID do cliente da identidade atribuída pelo usuário.
principalId	string	A ID principal da identidade atribuída pelo usuário.

Compartilhar via

Topics - Get

Parâmetros de URI

Respostas

Exemplos

Topics_Get

Solicitação de exemplo

Resposta de exemplo

Definições

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 adicionais