Compartilhar via


Domains - Create Or Update

Criar ou atualizar 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=2022-06-15

Parâmetros de URI

Nome Em Obrigatório Tipo Description
domainName
path True

string

Nome do domínio.

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.

api-version
query True

string

Versão da API a ser usada com a solicitação do cliente.

Corpo da solicitação

Nome Obrigatório Tipo Description
location True

string

Local do recurso.

identity

IdentityInfo

Informações de identidade para o recurso de Domínio da Grade de Eventos.

properties.autoCreateTopicWithFirstSubscription

boolean

Esse booliano é 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 do 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 for 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 poderá 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 gerenciada automaticamente, o usuário tem permissão para criar o tópico de domínio sob demanda, se necessário.

properties.autoDeleteTopicWithLastSubscription

boolean

Esse booliano é 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 true) ou autogerenciada (quando false). 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 for definida como false, o usuário precisará excluir manualmente o tópico de 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 de 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

Data Residency Limite do recurso.

properties.disableLocalAuth

boolean

Esse booliano é usado para habilitar ou desabilitar a autenticação local. O valor padrão é false. 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 domínio.

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

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 InputSchemaMapping que especificaram as informações sobre o conteúdo do evento de mapeamento.

properties.publicNetworkAccess

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

tags

object

Marcas do recurso.

Respostas

Nome Tipo Description
201 Created

Domain

Criado

Other Status Codes

Respostas de erro: ***

  • 400 Solicitação Inválida.

  • 500 Erro interno do servidor.

Exemplos

Domains_CreateOrUpdate

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1?api-version=2022-06-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 de exemplo

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

Nome Description
ConnectionState

Informações de ConnectionState.

createdByType

O tipo de identidade que criou o recurso.

DataResidencyBoundary

Data Residency Limite do recurso.

Domain

Domínio EventGrid.

DomainProvisioningState

Estado de provisionamento do recurso de domínio da Grade de Eventos.

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
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. Atualmente, 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 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 de 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.

UserIdentityProperties

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

ConnectionState

Informações de 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

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataResidencyBoundary

Data Residency Limite do recurso.

Nome Tipo Description
WithinGeopair

string

WithinRegion

string

Domain

Domínio EventGrid.

Nome Tipo Valor padrão Description
id

string

Identificador totalmente qualificado do recurso.

identity

IdentityInfo

Informações de identidade para o recurso de Domínio da Grade de Eventos.

location

string

Local do recurso.

name

string

Nome do recurso.

properties.autoCreateTopicWithFirstSubscription

boolean

True

Esse booliano é 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 do 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 for 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 poderá 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 gerenciada automaticamente, o usuário tem permissão para criar o tópico de domínio sob demanda, se necessário.

properties.autoDeleteTopicWithLastSubscription

boolean

True

Esse booliano é 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 true) ou autogerenciada (quando false). 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 for definida como false, o usuário precisará excluir manualmente o tópico de 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 de 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

Data Residency Limite do recurso.

properties.disableLocalAuth

boolean

False

Esse booliano é usado para habilitar ou desabilitar a autenticação local. O valor padrão é false. 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 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.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 Recurso de Domínio da Grade de Eventos.

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Informações sobre InputSchemaMapping que especificaram as informações sobre o conteúdo do evento de mapeamento.

properties.metricResourceId

string

ID do recurso de métrica para o recurso de domínio da Grade de Eventos.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista de conexões de ponto de extremidade privado.

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 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 de Domínio da Grade de Eventos.

tags

object

Marcas do recurso.

type

string

Tipo do recurso.

DomainProvisioningState

Estado de provisionamento do recurso de domínio da Grade de Eventos.

Nome Tipo Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

IdentityInfo

As informações de identidade do recurso.

Nome Tipo Description
principalId

string

A ID da entidade de segurança 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 de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. No momento, essa propriedade não é usada e 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 'None' removerá qualquer identidade.

Nome Tipo Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

InboundIpRule

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.

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.

Nome Tipo Description
CloudEventSchemaV1_0

string

CustomEventSchema

string

EventGridSchema

string

IpActionType

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

Nome 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 evento da Grade de Eventos. Atualmente, 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

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 junto 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 for fornecido ou se não houver 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

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 para a 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 para a 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 para a propriedade Subject do Evento da Grade de Eventos.

properties.topic

JsonField

As informações de mapeamento para a propriedade Topic do Evento da Grade de Eventos.

PersistedConnectionStatus

Status da conexão.

Nome Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateEndpoint

Informações de PrivateEndpoint.

Nome Tipo Description
id

string

O identificador arm para o ponto de extremidade privado.

PrivateEndpointConnection

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

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

Nome Tipo Description
Disabled

string

Enabled

string

ResourceProvisioningState

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

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

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.

UserIdentityProperties

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.