Topics - Update

Atualizar um tópico.
Atualiza de forma assíncrona um tópico com os parâmetros especificados.

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

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos na subscrição do utilizador.

subscriptionId
path True

string

Credenciais de subscrição que identificam exclusivamente uma subscrição do Microsoft Azure. O ID da subscrição 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 utilizar com o pedido de cliente.

Corpo do Pedido

Name Tipo Description
identity

IdentityInfo

Informações de identidade do recurso do tópico.

properties.dataResidencyBoundary

DataResidencyBoundary

O limite de residência dos dados para o tópico.

properties.disableLocalAuth

boolean

Este valor booleano é utilizado para ativar ou desativar a autenticação local. O valor predefinido é falso. Quando a propriedade está definida como verdadeira, apenas o token do AAD será utilizado para autenticar se o utilizador tiver permissão para publicar no tópico.

properties.inboundIpRules

InboundIpRule[]

Isto pode ser utilizado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: estes são considerados apenas se PublicNetworkAccess estiver ativado.

properties.publicNetworkAccess

PublicNetworkAccess

Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Pode restringir ainda mais a IPs específicos ao configurar

tags

object

Etiquetas do recurso Tópico.

Respostas

Name Tipo Description
200 OK

OK

201 Created

Topic

Pedido de atualização de tópicos aceite.

Other Status Codes

Respostas de Erro: ***

  • 400 Pedido Incorreto.

  • Erro de Servidor Interno 500.

Exemplos

Topics_Update

Pedido de amostra

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

{
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "inboundIpRules": [
      {
        "ipMask": "12.18.30.15",
        "action": "Allow"
      },
      {
        "ipMask": "12.18.176.1",
        "action": "Allow"
      }
    ]
  }
}

Resposta da amostra

{
  "properties": {
    "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled",
    "inboundIpRules": [
      {
        "ipMask": "12.18.30.15",
        "action": "Allow"
      },
      {
        "ipMask": "12.18.176.1",
        "action": "Allow"
      }
    ]
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
  "location": "westus2",
  "name": "exampletopic1",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "type": "Microsoft.EventGrid/topics"
}

Definições

Name Description
ConnectionState

Informações de ConnectionState.

createdByType

O tipo de identidade que criou o recurso.

DataResidencyBoundary

Data Residency Limite do recurso.

IdentityInfo

As informações de identidade do recurso.

IdentityType

O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade.

InboundIpRule
InputSchema

Isto determina o formato que o Event Grid deve esperar para eventos de entrada publicados no Recurso de Domínio do Event Grid.

IpActionType

Ação a executar com base na correspondência ou sem correspondência do IpMask.

JsonField

Isto é utilizado para expressar a origem de um mapeamento de esquema de entrada para um único campo de destino no esquema evento do Event Grid. Atualmente, isto é utilizado nos mapeamentos das propriedades "id", "topic" e "eventtime". Isto representa um campo no esquema de eventos de entrada.

JsonFieldWithDefault

Isto é utilizado para expressar a origem de um mapeamento de esquema de entrada para um único campo de destino no esquema evento do Event Grid. Atualmente, isto é utilizado nos mapeamentos das propriedades "assunto", "eventtype" e "dataversion". Isto representa um campo no esquema de eventos de entrada, juntamente com um valor predefinido a ser utilizado e deve ser fornecido pelo menos uma destas duas propriedades.

JsonInputSchemaMapping

Isto permite a publicação no Event Grid com um esquema de entrada personalizado. Isto pode ser utilizado para mapear propriedades de um esquema JSON de entrada personalizada para o esquema de eventos do Event Grid.

PersistedConnectionStatus

Estado da ligação.

PrivateEndpoint

Informações do PrivateEndpoint.

PrivateEndpointConnection
PublicNetworkAccess

Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Pode restringir ainda mais a IPs específicos ao configurar

ResourceProvisioningState

Estado de aprovisionamento da Ligação de Ponto Final Privado.

systemData

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

Topic

Tópico EventGrid

TopicProvisioningState

Estado de aprovisionamento do tópico.

TopicUpdateParameters

Propriedades da atualização do Tópico

UserIdentityProperties

As informações sobre a identidade do utilizador.

ConnectionState

Informações de ConnectionState.

Name Tipo Description
actionsRequired

string

Ações necessárias (se existirem).

description

string

Descrição do estado da ligação.

status

PersistedConnectionStatus

Estado da ligação.

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataResidencyBoundary

Data Residency Limite do recurso.

Name Tipo Description
WithinGeopair

string

WithinRegion

string

IdentityInfo

As informações de identidade do recurso.

Name Tipo Description
principalId

string

O ID principal da identidade de recurso.

tenantId

string

O ID do inquilino do recurso.

type

IdentityType

O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade.

userAssignedIdentities

<string,  UserIdentityProperties>

A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Esta propriedade não é atualmente utilizada e reservada para utilização futura.

IdentityType

O tipo de identidade gerida utilizada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá qualquer identidade.

Name Tipo Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

InboundIpRule

Name Tipo Description
action

IpActionType

Ação a executar com base na correspondência ou sem correspondência do IpMask.

ipMask

string

Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8.

InputSchema

Isto determina o formato que o Event Grid deve esperar para eventos de entrada publicados no Recurso de Domínio do Event Grid.

Name Tipo Description
CloudEventSchemaV1_0

string

CustomEventSchema

string

EventGridSchema

string

IpActionType

Ação a executar com base na correspondência ou sem correspondência do IpMask.

Name Tipo Description
Allow

string

JsonField

Isto é utilizado para expressar a origem de um mapeamento de esquema de entrada para um único campo de destino no esquema evento do Event Grid. Atualmente, isto é utilizado nos mapeamentos das propriedades "id", "topic" e "eventtime". Isto representa um campo no esquema de eventos de entrada.

Name Tipo Description
sourceField

string

Nome de um campo no esquema de eventos de entrada que deve ser utilizado como a origem de um mapeamento.

JsonFieldWithDefault

Isto é utilizado para expressar a origem de um mapeamento de esquema de entrada para um único campo de destino no esquema evento do Event Grid. Atualmente, isto é utilizado nos mapeamentos das propriedades "assunto", "eventtype" e "dataversion". Isto representa um campo no esquema de eventos de entrada, juntamente com um valor predefinido a ser utilizado e deve ser fornecido pelo menos uma destas duas propriedades.

Name Tipo Description
defaultValue

string

O valor predefinido a ser utilizado para mapeamento quando um Campo de Origem não é fornecido ou se não existir nenhuma propriedade com o nome especificado no payload de evento JSON publicado.

sourceField

string

Nome de um campo no esquema de eventos de entrada que deve ser utilizado como a origem de um mapeamento.

JsonInputSchemaMapping

Isto permite a publicação no Event Grid com um esquema de entrada personalizado. Isto pode ser utilizado para mapear propriedades de um esquema JSON de entrada personalizada para o esquema de eventos do Event Grid.

Name Tipo Description
inputSchemaMappingType string:

Json

Tipo de mapeamento personalizado

properties.dataVersion

JsonFieldWithDefault

As informações de mapeamento da propriedade DataVersion do Evento do Event Grid.

properties.eventTime

JsonField

As informações de mapeamento da propriedade EventTime do Evento do Event Grid.

properties.eventType

JsonFieldWithDefault

As informações de mapeamento da propriedade EventType do Evento do Event Grid.

properties.id

JsonField

As informações de mapeamento da propriedade ID do Evento do Event Grid.

properties.subject

JsonFieldWithDefault

As informações de mapeamento da propriedade Assunto do Evento do Event Grid.

properties.topic

JsonField

As informações de mapeamento da propriedade Tópico do Evento do Event Grid.

PersistedConnectionStatus

Estado da ligação.

Name Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateEndpoint

Informações do PrivateEndpoint.

Name Tipo Description
id

string

O identificador do ARM para o Ponto Final Privado.

PrivateEndpointConnection

Name Tipo Description
id

string

Identificador completamente qualificado do recurso.

name

string

Nome do recurso.

properties.groupIds

string[]

GroupIds do recurso do serviço de ligação privada.

properties.privateEndpoint

PrivateEndpoint

O recurso ponto final privado para esta Ligação.

properties.privateLinkServiceConnectionState

ConnectionState

Detalhes sobre o estado da ligação.

properties.provisioningState

ResourceProvisioningState

Estado de aprovisionamento da Ligação de Ponto Final Privado.

type

string

Tipo de recurso.

PublicNetworkAccess

Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Pode restringir ainda mais a IPs específicos ao configurar

Name Tipo Description
Disabled

string

Enabled

string

ResourceProvisioningState

Estado de aprovisionamento da Ligação de Ponto Final Privado.

Name Tipo Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

systemData

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

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

Topic

Tópico EventGrid

Name Tipo Default value Description
id

string

Identificador completamente qualificado do recurso.

identity

IdentityInfo

Informações de identidade do recurso.

location

string

Localização do recurso.

name

string

Nome do recurso.

properties.dataResidencyBoundary

DataResidencyBoundary

Data Residency Limite do recurso.

properties.disableLocalAuth

boolean

False

Este valor booleano é utilizado para ativar ou desativar a autenticação local. O valor predefinido é falso. Quando a propriedade está definida como verdadeira, apenas o token do AAD será utilizado para autenticar se o utilizador tiver permissão para publicar no tópico.

properties.endpoint

string

Ponto final para o tópico.

properties.inboundIpRules

InboundIpRule[]

Isto pode ser utilizado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: estes são considerados apenas se PublicNetworkAccess estiver ativado.

properties.inputSchema

InputSchema

EventGridSchema

Isto determina o formato que o Event Grid deve esperar para os eventos de entrada publicados no tópico.

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Isto permite a publicação através de esquemas de eventos personalizados. Pode especificar um InputSchemaMapping 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.privateEndpointConnections

PrivateEndpointConnection[]

properties.provisioningState

TopicProvisioningState

Estado de aprovisionamento do tópico.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Pode restringir ainda mais a IPs específicos ao configurar

systemData

systemData

Os metadados do sistema relacionados com o recurso tópico.

tags

object

Etiquetas do recurso.

type

string

Tipo de recurso.

TopicProvisioningState

Estado de aprovisionamento do tópico.

Name Tipo Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

TopicUpdateParameters

Propriedades da atualização do Tópico

Name Tipo Default value Description
identity

IdentityInfo

Informações de identidade do recurso do tópico.

properties.dataResidencyBoundary

DataResidencyBoundary

O limite de residência dos dados para o tópico.

properties.disableLocalAuth

boolean

Este valor booleano é utilizado para ativar ou desativar a autenticação local. O valor predefinido é falso. Quando a propriedade está definida como verdadeira, apenas o token do AAD será utilizado para autenticar se o utilizador tiver permissão para publicar no tópico.

properties.inboundIpRules

InboundIpRule[]

Isto pode ser utilizado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: estes são considerados apenas se PublicNetworkAccess estiver ativado.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Isto determina se o tráfego é permitido através da rede pública. Por predefinição, está ativado. Pode restringir ainda mais a IPs específicos ao configurar

tags

object

Etiquetas do recurso Tópico.

UserIdentityProperties

As informações sobre a identidade do utilizador.

Name Tipo Description
clientId

string

O ID de cliente da identidade atribuída pelo utilizador.

principalId

string

O ID principal da identidade atribuída pelo utilizador.