Compartir a través de


Domains - Create Or Update

Cree o actualice un dominio.
Crea o actualiza de forma asincrónica un nuevo dominio con los 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 identificador URI

Nombre En Requerido Tipo Description
domainName
path True

string

Nombre del dominio.

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.

api-version
query True

string

Versión de la API que se va a usar con la solicitud de cliente.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
location True

string

Ubicación del recurso.

identity

IdentityInfo

Información de identidad del recurso de dominio de Event Grid.

properties.autoCreateTopicWithFirstSubscription

boolean

Este valor booleano se usa para especificar el mecanismo de creación para "todos" los temas de dominio de Event Grid asociados a este recurso de dominio de Event Grid. En este contexto, la creación de un tema de dominio se puede administrar automáticamente (cuando es true) o autoadministrarse (cuando es false). El valor predeterminado de esta propiedad es true. Cuando esta propiedad es null o se establece en true, Event Grid es responsable de crear automáticamente el tema de dominio cuando se crea la primera suscripción de eventos en el ámbito del tema de dominio. Si esta propiedad está establecida en false, la creación de la primera suscripción de eventos requerirá la creación de un tema de dominio por parte del usuario. El modo de autoadministración se puede usar si el usuario quiere controlar al máximo cuándo se crea el tema de dominio, mientras que el modo administrado automáticamente proporciona la flexibilidad para realizar menos operaciones y administrar menos recursos por parte del usuario. Además, tenga en cuenta que, en el modo de creación administrada automáticamente, el usuario puede crear el tema de dominio a petición si es necesario.

properties.autoDeleteTopicWithLastSubscription

boolean

Este valor booleano se usa para especificar el mecanismo de eliminación para "todos" los temas de dominio de Event Grid asociados a este recurso de dominio de Event Grid. En este contexto, la eliminación del tema de dominio se puede administrar automáticamente (cuando es true) o autoadministrarse (cuando es false). El valor predeterminado de esta propiedad es true. Cuando esta propiedad se establece en true, Event Grid es responsable de eliminar automáticamente el tema de dominio cuando se elimina la última suscripción de eventos en el ámbito del tema de dominio. Si esta propiedad está establecida en false, el usuario debe eliminar manualmente el tema de dominio cuando ya no sea necesario (por ejemplo, cuando se elimina la última suscripción de eventos y el recurso debe limpiarse). El modo de autoadministración se puede usar si el usuario quiere tener control total de cuándo se debe eliminar el tema de dominio, mientras que el modo administrado automático proporciona la flexibilidad para realizar menos operaciones y administrar menos recursos por parte del usuario.

properties.dataResidencyBoundary

DataResidencyBoundary

Data Residency Límite del recurso.

properties.disableLocalAuth

boolean

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

properties.inboundIpRules

InboundIpRule[]

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

InputSchema

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

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Información sobre InputSchemaMapping que especificó la información sobre la carga del evento de asignación.

properties.publicNetworkAccess

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

tags

object

Etiquetas del recurso.

Respuestas

Nombre Tipo Description
201 Created

Domain

Creado

Other Status Codes

Respuestas de error: ***

  • 400 Solicitud incorrecta.

  • 500 Internal Server Error.

Ejemplos

Domains_CreateOrUpdate

Solicitud de ejemplo

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"
      }
    ]
  }
}

Respuesta de muestra

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

Definiciones

Nombre Description
ConnectionState

Información de ConnectionState.

createdByType

Tipo de identidad que creó el recurso.

DataResidencyBoundary

Data Residency Límite del recurso.

Domain

Dominio de EventGrid.

DomainProvisioningState

Estado de aprovisionamiento del recurso de dominio de Event Grid.

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

UserIdentityProperties

Información sobre la identidad del usuario.

ConnectionState

Información de ConnectionState.

Nombre Tipo Description
actionsRequired

string

Acciones necesarias (si las hay).

description

string

Descripción del estado de conexión.

status

PersistedConnectionStatus

Estado de la conexión.

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataResidencyBoundary

Data Residency Límite del recurso.

Nombre Tipo Description
WithinGeopair

string

WithinRegion

string

Domain

Dominio de EventGrid.

Nombre Tipo Valor predeterminado Description
id

string

Identificador completo del recurso.

identity

IdentityInfo

Información de identidad del recurso de dominio de Event Grid.

location

string

Ubicación del recurso.

name

string

Nombre del recurso.

properties.autoCreateTopicWithFirstSubscription

boolean

True

Este valor booleano se usa para especificar el mecanismo de creación para "todos" los temas de dominio de Event Grid asociados a este recurso de dominio de Event Grid. En este contexto, la creación de un tema de dominio se puede administrar automáticamente (cuando es true) o autoadministrarse (cuando es false). El valor predeterminado de esta propiedad es true. Cuando esta propiedad es null o se establece en true, Event Grid es responsable de crear automáticamente el tema de dominio cuando se crea la primera suscripción de eventos en el ámbito del tema de dominio. Si esta propiedad está establecida en false, la creación de la primera suscripción de eventos requerirá la creación de un tema de dominio por parte del usuario. El modo de autoadministración se puede usar si el usuario quiere controlar al máximo cuándo se crea el tema de dominio, mientras que el modo administrado automáticamente proporciona la flexibilidad para realizar menos operaciones y administrar menos recursos por parte del usuario. Además, tenga en cuenta que, en el modo de creación administrada automáticamente, el usuario puede crear el tema de dominio a petición si es necesario.

properties.autoDeleteTopicWithLastSubscription

boolean

True

Este valor booleano se usa para especificar el mecanismo de eliminación para "todos" los temas de dominio de Event Grid asociados a este recurso de dominio de Event Grid. En este contexto, la eliminación del tema de dominio se puede administrar automáticamente (cuando es true) o autoadministrarse (cuando es false). El valor predeterminado de esta propiedad es true. Cuando esta propiedad se establece en true, Event Grid es responsable de eliminar automáticamente el tema de dominio cuando se elimina la última suscripción de eventos en el ámbito del tema de dominio. Si esta propiedad está establecida en false, el usuario debe eliminar manualmente el tema de dominio cuando ya no sea necesario (por ejemplo, cuando se elimina la última suscripción de eventos y el recurso debe limpiarse). El modo de autoadministración se puede usar si el usuario quiere tener control total de cuándo se debe eliminar el tema de dominio, mientras que el modo administrado automático proporciona la flexibilidad para realizar menos operaciones y administrar menos recursos por parte del usuario.

properties.dataResidencyBoundary

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

properties.endpoint

string

Punto de conexión para el recurso de dominio de Event Grid que se usa para publicar los eventos.

properties.inboundIpRules

InboundIpRule[]

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

InputSchema

EventGridSchema

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

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Información sobre InputSchemaMapping que especificó la información sobre la carga del evento de asignación.

properties.metricResourceId

string

Identificador de recurso de métrica para el recurso de dominio de Event Grid.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista de conexiones de punto de conexión privado.

properties.provisioningState

DomainProvisioningState

Estado de aprovisionamiento del recurso de dominio de Event Grid.

properties.publicNetworkAccess

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

systemData

Metadatos del sistema relacionados con el recurso dominio de Event Grid.

tags

object

Etiquetas del recurso.

type

string

Tipo de recurso.

DomainProvisioningState

Estado de aprovisionamiento del recurso de dominio de Event Grid.

Nombre Tipo Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

IdentityInfo

Información de identidad del recurso.

Nombre Tipo Description
principalId

string

Identificador de entidad de seguridad de la identidad de recurso.

tenantId

string

Identificador de inquilino del recurso.

type

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.

userAssignedIdentities

<string,  UserIdentityProperties>

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.

Nombre Tipo Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

InboundIpRule

Nombre Tipo Description
action

IpActionType

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.

Nombre Tipo 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.

Nombre Tipo 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.

Nombre Tipo 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.

Nombre Tipo 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. Esto se puede usar para asignar propiedades de un esquema JSON de entrada personalizado al esquema de eventos de Event Grid.

Nombre Tipo Description
inputSchemaMappingType string:

Json

Tipo de la asignación personalizada

properties.dataVersion

JsonFieldWithDefault

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

properties.eventTime

JsonField

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

properties.eventType

JsonFieldWithDefault

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

properties.id

JsonField

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

properties.subject

JsonFieldWithDefault

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

properties.topic

JsonField

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

PersistedConnectionStatus

Estado de la conexión.

Nombre Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateEndpoint

Información de PrivateEndpoint.

Nombre Tipo Description
id

string

Identificador de ARM para punto de conexión privado.

PrivateEndpointConnection

Nombre Tipo Description
id

string

Identificador completo del recurso.

name

string

Nombre del recurso.

properties.groupIds

string[]

GroupIds del recurso del servicio Private Link.

properties.privateEndpoint

PrivateEndpoint

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

properties.privateLinkServiceConnectionState

ConnectionState

Detalles sobre el estado de la conexión.

properties.provisioningState

ResourceProvisioningState

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

Nombre Tipo Description
Disabled

string

Enabled

string

ResourceProvisioningState

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

Nombre Tipo 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.

Nombre Tipo Description
createdAt

string

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

createdBy

string

Identidad que creó el recurso.

createdByType

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

createdByType

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

UserIdentityProperties

Información sobre la identidad del usuario.

Nombre Tipo Description
clientId

string

Identificador de cliente de la identidad asignada por el usuario.

principalId

string

Identificador principal de la identidad asignada por el usuario.