Domains - Create Or Update

Referência

Serviço:: Event Grid

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

Crie ou atualize um domínio.
Cria ou atualiza de forma assíncrona um novo domínio com os parâmetros especificados.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
domainName	path	True	string	Nome do domínio.
resourceGroupName	path	True	string	O nome do grupo de recursos dentro da assinatura do usuário.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
location	True	string	Localização do recurso.
identity		IdentityInfo	Informações de identidade para o recurso Domínio da Grade de Eventos.
properties.autoCreateTopicWithFirstSubscription		boolean	Este Boolean é usado para especificar o mecanismo de criação para 'todos' os Tópicos de Domínio da Grade de Eventos associados a esse recurso de Domínio da Grade de Eventos. Nesse contexto, a criação de um tópico de domínio pode ser gerenciada automaticamente (quando true) ou autogerenciada (quando false). O valor padrão para essa propriedade é true. Quando essa propriedade é nula ou definida como true, a Grade de Eventos é responsável por criar automaticamente o tópico de domínio quando a primeira assinatura de evento é criada no escopo do tópico de domínio. Se essa propriedade estiver definida como false, a criação da primeira assinatura de evento exigirá a criação de um tópico de domínio pelo usuário. O modo de autogerenciamento pode ser usado se o usuário quiser controle total de quando o tópico de domínio é criado, enquanto o modo gerenciado automaticamente fornece a flexibilidade para executar menos operações e gerenciar menos recursos pelo usuário. Além disso, observe que, no modo de criação gerenciado automaticamente, o usuário tem permissão para criar o tópico de domínio sob demanda, se necessário.
properties.autoDeleteTopicWithLastSubscription		boolean	Este Boolean é usado para especificar o mecanismo de exclusão para 'todos' os Tópicos de Domínio da Grade de Eventos associados a esse recurso de Domínio da Grade de Eventos. Nesse contexto, a exclusão do tópico de domínio pode ser gerenciada automaticamente (quando verdadeira) ou autogerenciada (quando falsa). O valor padrão para essa propriedade é true. Quando essa propriedade é definida como true, a Grade de Eventos é responsável por excluir automaticamente o tópico de domínio quando a última assinatura de evento no escopo do tópico de domínio é excluída. Se essa propriedade estiver definida como false, o usuário precisará excluir manualmente o tópico do domínio quando ele não for mais necessário (por exemplo, quando a última assinatura de evento for excluída e o recurso precisar ser limpo). O modo de autogerenciamento pode ser usado se o usuário quiser controle total de quando o tópico do domínio precisa ser excluído, enquanto o modo gerenciado automaticamente fornece a flexibilidade para executar menos operações e gerenciar menos recursos pelo usuário.
properties.dataResidencyBoundary		DataResidencyBoundary	Limite de residência de dados do recurso.
properties.disableLocalAuth		boolean	Este booleano é usado para ativar ou desativar a autenticação local. O valor padrão é false. Quando a propriedade é definida como true, somente o token AAD será usado para autenticar se o usuário tiver permissão para publicar no domínio.
properties.eventTypeInfo		EventTypeInfo	Informações de tipo de evento para o domínio. Essas informações são fornecidas pelo editor e podem ser usadas pelo assinante para visualizar 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. Nota: Estes são considerados apenas se PublicNetworkAccess estiver ativado.
properties.inputSchema		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.
properties.inputSchemaMapping		InputSchemaMapping: JsonInputSchemaMapping	Informações sobre o InputSchemaMapping que especificou as informações sobre o mapeamento da carga útil do evento.
properties.minimumTlsVersionAllowed		TlsVersion	Versão TLS mínima do editor que pode publicar neste domínio
properties.publicNetworkAccess		PublicNetworkAccess	Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando
tags		object	Tags do recurso.

Respostas

Name	Tipo	Description
201 Created	Domain	Criado
Other Status Codes		Respostas de erro: *** 400 mau pedido. 500 Erro interno do servidor.

Name

Tipo

Description

201 Created

Domain

Criado

Other Status Codes

Respostas de erro: ***

400 mau pedido.
500 Erro interno do servidor.

Exemplos

Domains_CreateOrUpdate

Pedido de amostra

HTTP

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

{
  "location": "westus2",
  "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

Código de estado:: 201

{
  "properties": {
    "endpoint": "https://exampledomain1.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/domains/exampledomain1",
  "location": "westus2",
  "name": "exampledomain1",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "type": "Microsoft.EventGrid/domains"
}

Definições

Name	Description
ConnectionState	Informações de ConnectionState.
createdByType	O tipo de identidade que criou o recurso.
DataResidencyBoundary	Limite de residência de dados do recurso.
Domain	Domínio EventGrid.
DomainProvisioningState	Estado de provisionamento do recurso de domínio da grade de eventos.
EventDefinitionKind	O tipo de 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 'Nenhum' removerá qualquer identidade.
InboundIpRule
InlineEventProperties	Informações adicionais sobre cada evento em linha.
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 executar com base na correspondência ou não correspondência da IpMask.
JsonField	Isso é usado para expressar a origem de um mapeamento de esquema de entrada para um único campo de destino no esquema de Evento de Grade de Eventos. Isso é usado atualmente nos mapeamentos para as propriedades 'id', 'topic' e 'eventtime'. Isso representa um campo no esquema de eventos de entrada.
JsonFieldWithDefault	Isso é usado para expressar a origem de um mapeamento de esquema de entrada para um único campo de destino no esquema de Evento de Grade de Eventos. Isso é usado atualmente nos mapeamentos para as propriedades 'subject', 'eventtype' e 'dataversion'. Isso representa um campo no esquema de evento de entrada junto 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 na rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando
ResourceProvisioningState	Estado de provisionamento da Private Endpoint Connection.
systemData	Metadados referentes à criação e última modificação do recurso.
TlsVersion	Versão TLS mínima do editor que pode publicar neste domínio
UserIdentityProperties	As informações sobre a identidade do usuário.

ConnectionState

Informações de ConnectionState.

Name	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

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataResidencyBoundary

Limite de residência de dados do recurso.

Name	Tipo	Description
WithinGeopair	string
WithinRegion	string

Domain

Domínio EventGrid.

Name	Tipo	Default value	Description
id	string		Identificador totalmente qualificado do recurso.
identity	IdentityInfo		Informações de identidade para o recurso Domínio da Grade de Eventos.
location	string		Localização do recurso.
name	string		Nome do recurso.
properties.autoCreateTopicWithFirstSubscription	boolean	True	Este Boolean é usado para especificar o mecanismo de criação para 'todos' os Tópicos de Domínio da Grade de Eventos associados a esse recurso de Domínio da Grade de Eventos. Nesse contexto, a criação de um tópico de domínio pode ser gerenciada automaticamente (quando true) ou autogerenciada (quando false). O valor padrão para essa propriedade é true. Quando essa propriedade é nula ou definida como true, a Grade de Eventos é responsável por criar automaticamente o tópico de domínio quando a primeira assinatura de evento é criada no escopo do tópico de domínio. Se essa propriedade estiver definida como false, a criação da primeira assinatura de evento exigirá a criação de um tópico de domínio pelo usuário. O modo de autogerenciamento pode ser usado se o usuário quiser controle total de quando o tópico de domínio é criado, enquanto o modo gerenciado automaticamente fornece a flexibilidade para executar menos operações e gerenciar menos recursos pelo usuário. Além disso, observe que, no modo de criação gerenciado automaticamente, o usuário tem permissão para criar o tópico de domínio sob demanda, se necessário.
properties.autoDeleteTopicWithLastSubscription	boolean	True	Este Boolean é usado para especificar o mecanismo de exclusão para 'todos' os Tópicos de Domínio da Grade de Eventos associados a esse recurso de Domínio da Grade de Eventos. Nesse contexto, a exclusão do tópico de domínio pode ser gerenciada automaticamente (quando verdadeira) ou autogerenciada (quando falsa). O valor padrão para essa propriedade é true. Quando essa propriedade é definida como true, a Grade de Eventos é responsável por excluir automaticamente o tópico de domínio quando a última assinatura de evento no escopo do tópico de domínio é excluída. Se essa propriedade estiver definida como false, o usuário precisará excluir manualmente o tópico do domínio quando ele não for mais necessário (por exemplo, quando a última assinatura de evento for excluída e o recurso precisar ser limpo). O modo de autogerenciamento pode ser usado se o usuário quiser controle total de quando o tópico do domínio precisa ser excluído, enquanto o modo gerenciado automaticamente fornece a flexibilidade para executar menos operações e gerenciar menos recursos pelo usuário.
properties.dataResidencyBoundary	DataResidencyBoundary		Limite de residência de dados do recurso.
properties.disableLocalAuth	boolean	False	Este booleano é usado para ativar ou desativar a autenticação local. O valor padrão é false. Quando a propriedade é definida como true, somente o token AAD será usado para autenticar se o usuário tiver permissão para publicar no domínio.
properties.endpoint	string		Ponto de extremidade para o recurso de domínio da grade de eventos que é usado para publicar os eventos.
properties.eventTypeInfo	EventTypeInfo		Informações de tipo de evento para o domínio. Essas informações são fornecidas pelo editor e podem ser usadas pelo assinante para visualizar 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. Nota: Estes são considerados apenas se PublicNetworkAccess estiver ativado.
properties.inputSchema	InputSchema	EventGridSchema	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.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Informações sobre o InputSchemaMapping que especificou as informações sobre o mapeamento da carga útil do evento.
properties.metricResourceId	string		ID do recurso métrico para o Recurso de Domínio da Grade de Eventos.
properties.minimumTlsVersionAllowed	TlsVersion		Versão TLS mínima do editor que pode publicar neste domínio
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de conexões de ponto de extremidade privadas.
properties.provisioningState	DomainProvisioningState		Estado de provisionamento do recurso de domínio da grade de eventos.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Isso determina se o tráfego é permitido na 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 Grade de Eventos.
tags	object		Tags do recurso.
type	string		Tipo de recurso.

DomainProvisioningState

Estado de provisionamento do recurso de domínio da grade de eventos.

Name	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

EventDefinitionKind

O tipo de tipo de evento usado.

Name	Tipo	Description
Inline	string

EventTypeInfo

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

Name	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 do tipo string 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 tipo de evento usado.

IdentityInfo

As informações de identidade do recurso.

Name	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 'Nenhum' 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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Esta propriedade não é usada no momento e está reservada para uso futuro.

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 '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 não correspondência da IpMask.
ipMask	string	Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8.

InlineEventProperties

Informações adicionais sobre cada evento em linha.

Name	Tipo	Description
dataSchemaUrl	string	O dataSchemaUrl para o evento inline.
description	string	A descrição do evento embutido.
displayName	string	O displayName para o evento embutido.
documentationUrl	string	O documentationUrl para o evento inline.

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.

Name	Tipo	Description
CloudEventSchemaV1_0	string
CustomEventSchema	string
EventGridSchema	string

IpActionType

Ação a executar com base na correspondência ou não correspondência da IpMask.

Name	Tipo	Description
Allow	string

JsonField

Isso é usado para expressar a origem de um mapeamento de esquema de entrada para um único campo de destino no esquema de Evento de Grade de Eventos. Isso é usado atualmente nos mapeamentos para as propriedades 'id', 'topic' e 'eventtime'. Isso 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 usado como a origem de um mapeamento.

JsonFieldWithDefault

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

Name	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 na carga de evento JSON publicada.
sourceField	string	Nome de um campo no esquema de eventos de entrada que deve ser usado como a origem de um mapeamento.

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.

Name	Tipo	Description
inputSchemaMappingType	string: Json	Tipo de mapeamento personalizado
properties.dataVersion	JsonFieldWithDefault	As informações de mapeamento para a propriedade DataVersion do evento Event Grid.
properties.eventTime	JsonField	As informações de mapeamento para a propriedade EventTime do evento Event Grid.
properties.eventType	JsonFieldWithDefault	As informações de mapeamento para a propriedade EventType do evento Event Grid.
properties.id	JsonField	As informações de mapeamento para a propriedade Id do evento Event Grid.
properties.subject	JsonFieldWithDefault	As informações de mapeamento para a propriedade Subject do evento Event Grid.
properties.topic	JsonField	As informações de mapeamento para a propriedade Topic do evento Event Grid.

PersistedConnectionStatus

Status da conexão.

Name	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

Informações do PrivateEndpoint.

Name	Tipo	Description
id	string	O identificador ARM para Private Endpoint.

PrivateEndpointConnection

Name	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 Ponto Final Privado para esta Conexão.
properties.privateLinkServiceConnectionState	ConnectionState	Detalhes sobre o estado da conexão.
properties.provisioningState	ResourceProvisioningState	Estado de provisionamento da Private Endpoint Connection.
type	string	Tipo de recurso.

PublicNetworkAccess

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

Name	Tipo	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Estado de provisionamento da Private Endpoint Connection.

Name	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Metadados referentes à 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.

TlsVersion

Versão TLS mínima do editor que pode publicar neste domínio

Name	Tipo	Description
1.0	string
1.1	string
1.2	string

UserIdentityProperties

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

Name	Tipo	Description
clientId	string	O ID do cliente da identidade atribuída ao usuário.
principalId	string	O id principal da identidade atribuída ao usuário.

Partilhar via

Domains - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Domains_CreateOrUpdate

Pedido de amostra

Resposta da amostra

Definições

ConnectionState

createdByType

DataResidencyBoundary

Domain

DomainProvisioningState

EventDefinitionKind

EventTypeInfo

IdentityInfo

IdentityType

InboundIpRule

InlineEventProperties

InputSchema

IpActionType

JsonField

JsonFieldWithDefault

JsonInputSchemaMapping

PersistedConnectionStatus

PrivateEndpoint

PrivateEndpointConnection

PublicNetworkAccess

ResourceProvisioningState

systemData

TlsVersion

UserIdentityProperties

Recursos adicionais